MRTK3 GA Various Documentation Work

[AMollis]

This issue has been migrated a new MRTK repository, and the status of this issue will now be tracked at the following location:

• MRTK3 GA Various Documentation Work MixedRealityToolkit/MixedRealityToolkit-Unity#93

---

Overview

This task tracks the documentation work done using the provided parent task. No new work here.

Parent Task

• [GA Blocker] API Review for General Availability #11078

Tasks

Add Overview and How-To Documentation (GA)

• Add an overview page about Core interactions
  • Add something about MRTKBaseInteractable and when to should use this
  • Add something about StatefulInteractable and when to use this
• Add overview pages about Core subsystems
  • Add an overview page about DictationSubsystem @marlenaklein-msft
  • Add an overview page about HandsAggregatorSubsystem if reference in input docs is not enough.
  • Add an overview page about TextToSpeechSubsystem @marlenaklein-msft
• Add to Constraints Overview @AMollis
  • SpatialManipulation.FixedDistanceConstraint
  • SpatialManipulation.MaintainApparentSizeConstraint
  • SpatialManipulation.MoveAxisConstraint
  • SpatialManipulation.RotationAxisConstraint
• Add to Solvers Overview @AMollis
  • SpatialManipulation.Overlap
• Add to Diagnostics Overview @marlenaklein-msft
  • Add MRTKPerformanceStatsSubsystem name to overview. Image shows this, but need to add some text.
• Add to Input Overviews
  • Document MRTK Gaze Controller prefab and its components (InteractorDwellManager, FuzzyGazeIntector, ect.)
  • Document MRTK Hand Controller prefab and its components (GrabInteractor, NearInteractionModeDetector, MRTKPokeReticleVisual, @AMollis ProximityDetector,MRTKRayReticleVisual,MRTKLineVisual, RiggedHandMeshVisualizer, ect.)
  • May be document various IPoseSource types (FallbackCompositePoseSource, InputActionPoseSource, HandJointPoseSource, PinchPoseSource, PolyfillHandRayPoseSource)
  • Mention MRTKHandsAggregatorSubsystem in Hand Tracking overview @AMollis
  • Add ArticulatedHandController information to Hand Tracking overview @AMollis
  • Add ControllerVisualizer information to Interactor Architecture or Hand Tracking overview @AMollis
  • Add HandJointVisualizer information to Hand Tracking overview @AMollis
  • Add InteractionDetector information to Interaction Mode Manager document @AMollis
  • Add InteractionModeManager key word so this class name is searchable in overview @AMollis
  • Add WindowsMRKeyboard mention to System keyboard
  • Add InputSimulator mention to Input simulation and information on how to configure InputSimulator
• Add Windows Speech overview @marlenaklein-msft
  • Add information on WindowsDictationSubsystem
  • Add information on WindowsKeywordRecognitionSubsystem
  • Add information on WindowsTextToSpeechSubsystem
• Add UX documents @marlenaklein-msft
  • Add Non-Canvas Dialog overview
  • Add component details to button overview (InteractablePulse, FontIconSelector, RectTransformColliderFitter)
  • Add Keyboard canvas UI overview (KeyboardPreview, MRTKTMPInputField, MRTKUGUIInputField)
  • Add TabView overview (core ux)
  • Add VirtualizedScrollRectList overview (core ux)

Add Comment Blocks for API Reference Docs (GA)

• TransformFlags enum values
• VariableRangeAttribute constructor and properties
• TextToSpeechSubsystem class definition
• HandDataContainer class definition definition and public members

[AMollis]

Work is already done