Move Spec related a11y doc to codegen section and promote the one from Mountable Components to top level

mkarpio · facebook-github-bot · commit caf015b47c83 · 2022-12-14T08:50:23.000-08:00
Summary: Top level docs should discuss kotlin APIs, so the old a11y doc got moved to codegen section, and replaced with the a11y doc written for Mountable Components (with small adjustments to cover not only Mountable Components, but Style operations in general).

Reviewed By: apowolny

Differential Revision: D42034502

fbshipit-source-id: 49d9fc919429fce91f3b175037510db026d021a5
diff --git a/docs/accessibility/accessibility.mdx b/docs/accessibility/accessibility.mdx
@@ -13,11 +13,11 @@ This page provides details of the Litho components, methods, nodes, events, and
 For information on how Meta is committed to creating a full UI experience for **all** people, see the [Meta Accessibility](https://en-gb.facebook.com/accessibility/) site.
 :::
 
-## Implementing Accessibility features for Mountable Components
+## Implementing Accessibility features
 
-Accessibility properties and events for mountable components can be implemented by adding them to the `Style` object that will be returned by the `MountableRenderResult` object from the `render()` method.
+Accessibility properties and events for components can be implemented by adding them to the `Style` object.
 
-Following is example of how to combine a `Style`, that was passed to a mountable component, with a newly created `Style` object that implements accessibility properties and events:
+Following is an example of how to combine a `Style`, that was passed to a mountable component, with a newly created `Style` object that implements accessibility properties and events and will be returned on the `MountableRenderResult` object from the `render()` method:
 
 ```kotlin file=sample/src/main/java/com/facebook/samples/litho/kotlin/mountables/SimpleImageViewWithAccessibility.kt start=start_simple_mountable_component_with_a11y_example end=end_simple_mountable_component_with_a11y_example
 ```
diff --git a/docs/codegen/accessibility-overview.md b/docs/codegen/accessibility-overview.md
diff --git a/docs/codegen/overview.mdx b/docs/codegen/overview.mdx
@@ -12,6 +12,7 @@ The documentation for Codegen APIs includes the following pages:
 
 * [Layout Specs](layout-specs.mdx) - the logical equivalents of composite views on Android.
 * [Mount Specs](mount-specs.md) - components that can render views or drawables.
+* [Accessibility](accessibility-overview.md) - explains why accessibility is important and how to implement accessibility features, and lists the supported accessibility events of the `Style` object.
 * [Sections API](sections/start.mdx) - documentation for the Sections API for writing lists.
 * [Props](passing-data-to-components/props.md) and [TreeProps](passing-data-to-components/treeprops.mdx) - the ways you can pass data to components.
 * [State in Specs](state-for-specs.md) - data that is encapsulated and managed within the component and is transparent to its parent.
diff --git a/docs/kotlin/cheatsheet.mdx b/docs/kotlin/cheatsheet.mdx
@@ -44,6 +44,6 @@ The following cheatsheet provides a set of links for the migration of individual
 | @OnBoundsDefined |  [measure()](../mainconcepts/mountablecomponents/mountable-measuring.mdx) |
 | @OnPrepare |  [MountableComponentScope.render()](../mainconcepts/mountablecomponents/mountable-component.mdx) |
 | @OnLoadStyle | [MountableComponentScope.render()](../mainconcepts/mountablecomponents/mountable-component.mdx) |
-| Accessibility | [Accessibility for Mountable Components](../mainconcepts/mountablecomponents/accessibility.mdx) (see: [AccessibilityStyles](https://fburl.com/code/3ikzp6c7))|
+| Accessibility | [Accessibility for Mountable Components](../accessibility/accessibility.mdx) (see: [AccessibilityStyles](https://fburl.com/code/3ikzp6c7))|
 | hasChildLithoViews | [doesMountRenderTreeHosts()](https://fburl.com/doesmountrendertreehosts)|
 | isPureRender | No equivalent. Ignore when converting. |
diff --git a/docs/kotlin/migrating-from-mountspecs.mdx b/docs/kotlin/migrating-from-mountspecs.mdx
@@ -49,7 +49,7 @@ More information on how to migrate Hooks can be found on the [Hooks](../kotlin/h
 
 ### Migrating Accessibility
 
-Accessibility for Mountable Components is implemented using the `Style` object. You can find out more about how to implement A11Y for Mountable Components on the dedicated [Accessibility](../mainconcepts/mountablecomponents/accessibility.mdx) page.
+Accessibility for Mountable Components is implemented using the `Style` object. You can find out more about how to implement A11Y for Mountable Components on the dedicated [Accessibility](../accessibility/accessibility.mdx) page.
 
 ### Migrating event handling
 
diff --git a/docs/mainconcepts/mountablecomponents/overview.mdx b/docs/mainconcepts/mountablecomponents/overview.mdx
@@ -15,7 +15,6 @@ The Mountable Components section contains the following pages:
 * [BindTo - Dynamic Values API](mountable-bindto.mdx) - illustrates the use of the BindTo API by implementing a simple `ImageViewComponent` with specific properties, which are animated based on the values of a `SeekBar`.
 * [Controllers Pattern](mountable-controllers.mdx) - illustrates the use of controllers by implementing a simple TimePicker that shows an arbitrary time.
 * [Content Pooling](mountable-preallocation.mdx) - details a strategy that can be used to populate the content pools to optimise first mount performance.
-* [Accessibility](accessibility.mdx) - explains why accessibility is important and how to implement accessibility features, and lists the supported accessibility events of the `Style` object.
 
 Information and step-by-step explanations of how to migrate to Mountable Components from already existing components can be found in the following documents:
 * [Migrating from MountSpecs](../../kotlin/migrating-from-mountspecs.mdx) - details the process of migrating from MountSpec API.
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -53,7 +53,6 @@ module.exports = {
           'mainconcepts/mountablecomponents/mountable-bindto',
           'mainconcepts/mountablecomponents/mountable-controllers',
           'mainconcepts/mountablecomponents/mountable-preallocation',
-          'mainconcepts/mountablecomponents/accessibility',
         ]
       },
       {
@@ -90,7 +89,7 @@ module.exports = {
       // TODO: Kotlin-ify
       'mainconcepts/coordinate-state-actions/visibility-handling',
     ],
-    'Accessibility': ['accessibility/accessibility-overview'],
+    'Accessibility': ['accessibility/accessibility'],
     // TODO: revisit wording to make it clear it's not just the 'kotlin' testing API
     'Testing': [
       'kotlin/testing-getting-started',
@@ -109,6 +108,7 @@ module.exports = {
       'codegen/overview',
       'codegen/layout-specs',
       'codegen/mount-specs',
+      'codegen/accessibility-overview',
       {
         'Sections API': [
           'sections/start',
