Move guidelines checklist outside versioning (#216)

* move outside versioning * rename file * custom autogenerate sidebar * specify custom sidebar
FormidableLabs · Jul 26, 2024 · 5feb51d · 5feb51d
1 parent 1894a09
commit 5feb51d
Show file tree

Hide file tree

Showing 74 changed files with 158 additions and 829 deletions.
diff --git a/...ite/docs/checklist/bottom-sheet-drawer.md → website/checklist/bottom-sheet-drawer.md b/...ite/docs/checklist/bottom-sheet-drawer.md → website/checklist/bottom-sheet-drawer.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import BottomSheet from './bottomsheet.png';
 
 # BottomSheet & Drawers

diff --git a/...te/docs/checklist/bottom-tab-navigator.md → website/checklist/bottom-tab-navigator.md b/...te/docs/checklist/bottom-tab-navigator.md → website/checklist/bottom-tab-navigator.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import TabBar from './tabbar.png';
 
 # Bottom Tab Navigator

diff --git a/...ite/docs/checklist/bottomsheet.excalidraw → website/checklist/bottomsheet.excalidraw b/...ite/docs/checklist/bottomsheet.excalidraw → website/checklist/bottomsheet.excalidraw
diff --git a/website/docs/checklist/bottomsheet.png → website/checklist/bottomsheet.png b/website/docs/checklist/bottomsheet.png → website/checklist/bottomsheet.png
diff --git a/website/docs/checklist/button.md → website/checklist/button.md b/website/docs/checklist/button.md → website/checklist/button.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import Button from './button.png';
 
 # Button

diff --git a/website/docs/checklist/button.png → website/checklist/button.png b/website/docs/checklist/button.png → website/checklist/button.png
diff --git a/website/docs/checklist/buttons.excalidraw → website/checklist/buttons.excalidraw b/website/docs/checklist/buttons.excalidraw → website/checklist/buttons.excalidraw
diff --git a/website/checklist/carousel.md b/website/checklist/carousel.md
@@ -0,0 +1,5 @@
+---
+displayed_sidebar: checklist
+---
+
+# Carousel
diff --git a/website/docs/checklist/focus.excalidraw → website/checklist/focus.excalidraw b/website/docs/checklist/focus.excalidraw → website/checklist/focus.excalidraw
diff --git a/website/docs/checklist/focus.gif → website/checklist/focus.gif b/website/docs/checklist/focus.gif → website/checklist/focus.gif
diff --git a/website/docs/checklist/focus.md → website/checklist/focus.md b/website/docs/checklist/focus.md → website/checklist/focus.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import Focus from './focus.gif';
 
 # Focus

diff --git a/website/docs/checklist/form-disabled.png → website/checklist/form-disabled.png b/website/docs/checklist/form-disabled.png → website/checklist/form-disabled.png
diff --git a/website/docs/checklist/form-error.png → website/checklist/form-error.png b/website/docs/checklist/form-error.png → website/checklist/form-error.png
diff --git a/website/docs/checklist/form-focused.png → website/checklist/form-focused.png b/website/docs/checklist/form-focused.png → website/checklist/form-focused.png
diff --git a/website/docs/checklist/form-selected.png → website/checklist/form-selected.png b/website/docs/checklist/form-selected.png → website/checklist/form-selected.png
diff --git a/website/docs/checklist/form.excalidraw → website/checklist/form.excalidraw b/website/docs/checklist/form.excalidraw → website/checklist/form.excalidraw
diff --git a/website/docs/checklist/forms.md → website/checklist/forms.md b/website/docs/checklist/forms.md → website/checklist/forms.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import FormDisabled from './form-disabled.png';
 import FormError from './form-error.png';
 import FormFocused from './form-focused.png';

diff --git a/website/docs/checklist/grid.excalidraw → website/checklist/grid.excalidraw b/website/docs/checklist/grid.excalidraw → website/checklist/grid.excalidraw
diff --git a/website/docs/checklist/grid.png → website/checklist/grid.png b/website/docs/checklist/grid.png → website/checklist/grid.png
diff --git a/website/docs/checklist/headers.excalidraw → website/checklist/headers.excalidraw b/website/docs/checklist/headers.excalidraw → website/checklist/headers.excalidraw
diff --git a/website/docs/checklist/headers.png → website/checklist/headers.png b/website/docs/checklist/headers.png → website/checklist/headers.png
diff --git a/website/docs/checklist/headings.md → website/checklist/headings.md b/website/docs/checklist/headings.md → website/checklist/headings.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import Headers from './headers.png';
 
 # Headings

diff --git a/website/docs/checklist/checklist.md → website/checklist/index.md b/website/docs/checklist/checklist.md → website/checklist/index.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 0
+displayed_sidebar: checklist
 ---
 
 # Accessibility Checklist

diff --git a/website/docs/checklist/list-grids.md → website/checklist/list-grids.md b/website/docs/checklist/list-grids.md → website/checklist/list-grids.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import Grid from './grid.png';
 
 # List & Grids

diff --git a/website/docs/checklist/tabbar.excalidraw → website/checklist/tabbar.excalidraw b/website/docs/checklist/tabbar.excalidraw → website/checklist/tabbar.excalidraw
diff --git a/website/docs/checklist/tabbar.png → website/checklist/tabbar.png b/website/docs/checklist/tabbar.png → website/checklist/tabbar.png
diff --git a/website/docs/checklist/text.excalidraw → website/checklist/text.excalidraw b/website/docs/checklist/text.excalidraw → website/checklist/text.excalidraw
diff --git a/website/docs/checklist/text.gif → website/checklist/text.gif b/website/docs/checklist/text.gif → website/checklist/text.gif
diff --git a/website/docs/checklist/text.md → website/checklist/text.md b/website/docs/checklist/text.md → website/checklist/text.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 import Text from './text.gif';
 
 # Text

diff --git a/website/docs/checklist/timed-actions.md → website/checklist/timed-actions.md b/website/docs/checklist/timed-actions.md → website/checklist/timed-actions.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: checklist
+---
+
 # Timed Actions
 
 | User    | I Can                                                                        |

diff --git a/website/docs/checklist/carousel.md b/website/docs/checklist/carousel.md
diff --git a/website/docs/guidelines/accessibility-hint.md b/website/docs/guidelines/accessibility-hint.md
diff --git a/website/docs/guidelines/grouping.md b/website/docs/guidelines/grouping.md
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -139,24 +139,39 @@ const config: Config = {
         ...defaultPresets,
       },
     ],
-    // [
-    //   '@docusaurus/plugin-content-docs',
-    //   {
-    //     id: 'guidelines',
-    //     path: '../docs/guidelines',
-    //     routeBasePath: 'guidelines',
-    //     ...defaultPresets,
-    //   },
-    // ],
-    // [
-    //   '@docusaurus/plugin-content-docs',
-    //   {
-    //     id: 'checklist',
-    //     path: '../docs/checklist',
-    //     routeBasePath: '/checklist/',
-    //     ...defaultPresets,
-    //   },
-    // ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'guidelines',
+        path: 'guidelines',
+        routeBasePath: 'guidelines',
+        async sidebarItemsGenerator({
+          defaultSidebarItemsGenerator,
+          numberPrefixParser,
+          item,
+          version,
+          docs,
+          categoriesMetadata,
+          isCategoryIndex,
+        }) {
+          // Example: return an hardcoded list of static sidebar items
+          return [
+            { type: 'doc', id: 'bottomsheet' },
+            { type: 'doc', id: 'bottomsheet' },
+          ];
+        },
+        ...defaultPresets,
+      },
+    ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'checklist',
+        path: 'checklist',
+        routeBasePath: '/checklist/',
+        ...defaultPresets,
+      },
+    ],
   ],
   themeConfig: {
     docs: {
@@ -176,17 +191,14 @@ const config: Config = {
           to: '/docs/',
         },
         {
-          type: 'docsVersion',
-          to: 'docs/guidelines',
           position: 'left',
           label: 'Guidelines',
           to: '/guidelines/',
         },
         {
-          type: 'docsVersion',
           label: 'Checklist',
           position: 'left',
-          to: 'docs/checklist',
+          to: '/checklist/',
         },
         {
           label: 'Packages',

diff --git a/...on-0.7.x/guidelines/accessibility-hint.md → website/guidelines/accessibility-hint.md b/...on-0.7.x/guidelines/accessibility-hint.md → website/guidelines/accessibility-hint.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: guidelines
+---
+
 # Accessibility Hint
 
 Accessibility hint helps users understand the element's purpose when the accessibility label alone is not enough.
@@ -8,12 +12,15 @@ For example:
   accessible={true}
   accessibilityLabel="Like"
   accessibilityHint="Likes the song"
-  onPress={onPress}>
-  <View style={styles.button}>lib
+  onPress={onPress}
+>
+  <View style={styles.button}>
+    lib
     <Text style={styles.buttonText}>Like</Text>
   </View>
 </TouchableOpacity>
 ```
+
 In the example announcing only "Like" might be not enough for a screen reader user, so we've added the extra information: "Likes the song."
 
 :::danger

diff --git a/...te/docs/guidelines/accessibility-label.md → website/guidelines/accessibility-label.md b/...te/docs/guidelines/accessibility-label.md → website/guidelines/accessibility-label.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Understandable
 ama_affected_users: Visual
 ama_success_criterion: 4.1.2@https://www.w3.org/WAI/WCAG21/Understanding/name-role-value.html
+displayed_sidebar: guidelines
 ---
 
 # Accessibility Label

diff --git a/...ite/docs/guidelines/accessibility-role.md → website/guidelines/accessibility-role.md b/...ite/docs/guidelines/accessibility-role.md → website/guidelines/accessibility-role.md
@@ -3,6 +3,7 @@ ama_severity: Critical
 ama_category: Operable
 ama_affected_users: Visual, Motor
 ama_success_criterion: 4.1.2@https://www.w3.org/WAI/WCAG21/Understanding/name-role-value.html
+displayed_sidebar: guidelines
 ---
 
 # Accessibility Role

diff --git a/...e/docs/guidelines/accessibility-states.md → website/guidelines/accessibility-states.md b/...e/docs/guidelines/accessibility-states.md → website/guidelines/accessibility-states.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Understandable
 ama_affected_users: Visual
 ama_success_criterion: 4.1.2@https://www.w3.org/WAI/WCAG21/Understanding/name-role-value.html
+displayed_sidebar: guidelines
 ---
 
 # Accessibility States

diff --git a/.../docs/guidelines/android-list-feature.gif → website/guidelines/android-list-feature.gif b/.../docs/guidelines/android-list-feature.gif → website/guidelines/android-list-feature.gif
diff --git a/website/docs/guidelines/animations.md → website/guidelines/animations.md b/website/docs/guidelines/animations.md → website/guidelines/animations.md
@@ -3,6 +3,7 @@ ama_severity: Critical
 ama_category: Operable
 ama_affected_users: Cognitive
 ama_success_criterion: 2.3.3@https://www.w3.org/WAI/WCAG21/Understanding/animation-from-interactions.html
+displayed_sidebar: guidelines
 ---
 
 # Animations

diff --git a/website/docs/guidelines/bottomsheet.md → website/guidelines/bottomsheet.md b/website/docs/guidelines/bottomsheet.md → website/guidelines/bottomsheet.md
@@ -3,6 +3,7 @@ ama_severity: Critical
 ama_category: Operable
 ama_affected_users: Visual, Motor, Cognitive
 ama_success_criterion: 2.3.3@https://www.w3.org/WAI/WCAG21/Understanding/animation-from-interactions.html
+displayed_sidebar: guidelines
 ---
 
 # BottomSheet & Drawer

diff --git a/website/docs/guidelines/carousel.md → website/guidelines/carousel.md b/website/docs/guidelines/carousel.md → website/guidelines/carousel.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Operable
 ama_affected_users: Visual, Motor
 ama_success_criterion: 2.3.3@https://www.w3.org/WAI/WCAG21/Understanding/animation-from-interactions.html
+displayed_sidebar: guidelines
 ---
 
 # Carousel

diff --git a/website/docs/guidelines/contrast.md → website/guidelines/contrast.md b/website/docs/guidelines/contrast.md → website/guidelines/contrast.md
@@ -3,6 +3,7 @@ ama_severity: Critical
 ama_category: Perceivable
 ama_affected_users: Vision
 ama_success_criterion: 1.4.3@https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum
+displayed_sidebar: guidelines
 ---
 
 # Contrast

diff --git a/...ocs/guidelines/email-field-with-error.png → ...ite/guidelines/email-field-with-error.png b/...ocs/guidelines/email-field-with-error.png → ...ite/guidelines/email-field-with-error.png
diff --git a/website/docs/guidelines/focus.md → website/guidelines/focus.md b/website/docs/guidelines/focus.md → website/guidelines/focus.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Operable
 ama_affected_users: Visual, Mobility, Cognitive
 ama_success_criterion: 2.4.3@https://www.w3.org/WAI/WCAG21/Understanding/focus-order
+displayed_sidebar: guidelines
 ---
 
 # Focus

diff --git a/website/docs/guidelines/forms.md → website/guidelines/forms.md b/website/docs/guidelines/forms.md → website/guidelines/forms.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Operable
 ama_affected_users: Visual, Mobility, Cognitive
 ama_success_criterion: 3.3@https://www.w3.org/WAI/WCAG21/Understanding/input-assistance
+displayed_sidebar: guidelines
 ---
 
 import EmailFieldWithError from './email-field-with-error.png';

diff --git a/website/guidelines/grouping.md b/website/guidelines/grouping.md
@@ -0,0 +1,5 @@
+---
+displayed_sidebar: guidelines
+---
+
+# Grouping
diff --git a/website/docs/guidelines/headers.md → website/guidelines/headers.md b/website/docs/guidelines/headers.md → website/guidelines/headers.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Operable
 ama_affected_users: Visual, Mobility
 ama_success_criterion: 2.4.6@https://www.w3.org/WAI/WCAG21/Understanding/headings-and-labels
+displayed_sidebar: guidelines
 ---
 
 import AndroidListFeature from './android-list-feature.gif';

diff --git a/website/docs/guidelines/guidelines.md → website/guidelines/index.md b/website/docs/guidelines/guidelines.md → website/guidelines/index.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+displayed_sidebar: guidelines
 ---
 
 # Mobile Accessibility Guidelines

diff --git a/website/docs/guidelines/lists-grids.md → website/guidelines/lists-grids.md b/website/docs/guidelines/lists-grids.md → website/guidelines/lists-grids.md
@@ -2,6 +2,7 @@
 ama_severity: Serious
 ama_category: Perceivable
 ama_affected_users: Visual, Mobility
+displayed_sidebar: guidelines
 ---
 
 # Lists & Grids

diff --git a/website/docs/guidelines/minimum-size.md → website/guidelines/minimum-size.md b/website/docs/guidelines/minimum-size.md → website/guidelines/minimum-size.md
@@ -2,6 +2,7 @@
 ama_severity: Serious
 ama_category: Operable
 ama_affected_users: Visual, Mobility
+displayed_sidebar: guidelines
 ---
 
 # Minimum Size

diff --git a/website/docs/guidelines/next-key.jpg → website/guidelines/next-key.jpg b/website/docs/guidelines/next-key.jpg → website/guidelines/next-key.jpg
diff --git a/website/docs/guidelines/pour.md → website/guidelines/pour.md b/website/docs/guidelines/pour.md → website/guidelines/pour.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+displayed_sidebar: guidelines
 ---
 
 # POUR - Accessibility Principles

diff --git a/website/docs/guidelines/text.md → website/guidelines/text.md b/website/docs/guidelines/text.md → website/guidelines/text.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Perceivable
 ama_affected_users: Visual, Mobility
 ama_success_criterion: 2.1@https://www.w3.org/WAI/WCAG21/Understanding/distinguishable
+displayed_sidebar: guidelines
 ---
 
 # Text

diff --git a/website/docs/guidelines/timed-actions.md → website/guidelines/timed-actions.md b/website/docs/guidelines/timed-actions.md → website/guidelines/timed-actions.md
@@ -3,6 +3,7 @@ ama_severity: Serious
 ama_category: Perceivable
 ama_affected_users: Visual, Mobility
 ama_success_criterion: 2.2.1@https://www.w3.org/WAI/WCAG21/Understanding/timing-adjustable
+displayed_sidebar: guidelines
 ---
 
 # Timed actions

diff --git a/...uidelines/type-of-accessibility-issues.md → ...uidelines/type-of-accessibility-issues.md b/...uidelines/type-of-accessibility-issues.md → ...uidelines/type-of-accessibility-issues.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+displayed_sidebar: guidelines
 ---
 
 # Type of Accessibility Issues