[#638] Review: Add missing titles in summaries and remove empty sections

Orange-OpenSource · Oct 13, 2023 · 2aced85 · 2aced85
1 parent 8ffd5c4
commit 2aced85
Show file tree

Hide file tree

Showing 22 changed files with 239 additions and 326 deletions.
diff --git a/docs/components/AppBarsBottom.md b/docs/components/AppBarsBottom.md
@@ -8,8 +8,6 @@ description: A bottom app bar displays navigation and key actions at the bottom
 
 * [Specifications references](#specifications-references)
 * [Accessibility](#accessibility)
-* [Implementation](#implementation)
-* [Component specific tokens](#component-specific-tokens)
 
 ---
 
@@ -30,12 +28,4 @@ action performs. While optional, their use is strongly encouraged.
 
 When using icons for navigation icons, action items and other elements of bottom
 app bars, you should set a content description on them so that screen readers
-like TalkBack are able to announce their purpose or action, if any.
-
-## Implementation
-
-_Soon available_
-
-## Component specific tokens
-
-_Soon available_
+like TalkBack are able to announce their purpose or action, if any.
diff --git a/docs/components/AppBarsTop.md b/docs/components/AppBarsTop.md
@@ -10,8 +10,11 @@ description: Top app bars display information and actions relating to the curren
 * [Accessibility](#accessibility)
 * [Variants](#variants)
     * [Regular top app bar](#regular-top-app-bar)
+        * [Jetpack Compose](#jetpack-compose)
+            * [OdsTopAppBar API](#odstopappbar-api)
     * [Large top app bar](#large-top-app-bar)
-* [Component specific tokens](#component-specific-tokens)
+        * [Jetpack Compose](#jetpack-compose-1)
+            * [OdsLargeTopAppBar API](#odslargetopappbar-api)
 
 ---
 
@@ -32,7 +35,7 @@ action performs.
 
 ### Regular top app bar
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Add `OdsTopAppBar` composable to your Scaffold `topBar`.
 Here is an example of use:
@@ -77,13 +80,9 @@ Parameter | Default&nbsp;value | Description
 `elevated: Boolean` | `true` | Controls the elevation of the top app bar: `true` to set an elevation to the top app bar (a shadow is displayed below), `false` otherwise
 {:.table}
 
-#### XML implementation
-
-_Not available_
-
 ### Large top app bar
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 First, you have to add this line in your application `build.gradle.kts` file cause this component relies on Compose Material 3 implementation:
 
@@ -156,7 +155,3 @@ Parameter | Default&nbsp;value | Description
 `overflowMenuActions: List<OdsTopAppBarOverflowMenuActionItem>` | `emptyList()` | Actions displayed in the overflow menu
 `scrollBehavior: TopAppBarScrollBehavior?` | `null` | `TopAppBarScrollBehavior` attached to the top app bar
 {:.table}
-
-## Component specific tokens
-
-_Soon available_
diff --git a/docs/components/Banners.md b/docs/components/Banners.md
@@ -15,7 +15,8 @@ Only one banner should be shown at a time
 * [Specifications references](#specifications-references)
 * [Accessibility](#accessibility)
 * [Implementation](#implementation)
-* [Component specific tokens](#component-specific-tokens)
+    * [Jetpack Compose](#jetpack-compose)
+        * [OdsBanner API](#odsbanner-api)
 
 ---
 
@@ -59,11 +60,3 @@ Parameter | Default&nbsp;value | Description
 `image: OdsBannerImage?` | `null` | Image displayed in the banner in a circle shape
 `secondButton: OdsBannerButton?` | `null` | Secondary button displayed into the banner next to the primary one
 {:.table}
-
-### XML
-
-_Soon available_
-
-## Component specific tokens
-
-_Soon available_
diff --git a/docs/components/Buttons.md b/docs/components/Buttons.md
@@ -10,13 +10,26 @@ description: Buttons allow users to take actions, and make choices, with a singl
 * [Accessibility](#accessibility)
 * [Variants](#variants)
     * [Contained button](#contained-button)
+        * [Jetpack Compose](#jetpack-compose)
+            * [OdsButton API](#odsbutton-api)
     * [Text button](#text-button)
+        * [Jetpack Compose](#jetpack-compose-1)
+            * [OdsTextButton API](#odstextbutton-api)
     * [Outlined button](#outlined-button)
+        * [Jetpack Compose](#jetpack-compose-2)
+            * [OdsOutlinedButton API](#odsoutlinedbutton-api)
     * [Text toggle buttons group](#text-toggle-buttons-group)
+        * [Jetpack Compose](#jetpack-compose-3)
+            * [OdsTextToggleButtonsRow API](#odstexttogglebuttonsrow-api)
     * [Icon button](#icon-button)
+        * [Jetpack Compose](#jetpack-compose-4)
+            * [OdsIconButton API](#odsiconbutton-api)
     * [Icon toggle button](#icon-toggle-button)
+        * [Jetpack Compose](#jetpack-compose-5)
+            * [OdsIconToggleButton API](#odsicontogglebutton-api)
     * [Icon toggle buttons group](#icon-toggle-buttons-group)
-* [Component specific tokens](#component-specific-tokens)
+        * [Jetpack Compose](#jetpack-compose-6)
+            * [OdsIconToggleButtonsRow API](#odsicontogglebuttonsrow-api)
 
 ---
 
@@ -50,7 +63,7 @@ Functional negative:
 
 ![ContainedButton negative light](images/button_contained_negative_light.png) ![ContainedButton negative dark](images/button_contained_negative_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsButton` composable:
 
@@ -89,18 +102,14 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Text button
 
 Text buttons are typically used for less-pronounced actions, including those located in dialogs and
 cards. In cards, text buttons help maintain an emphasis on card content.
 
 ![TextButton](images/button_text_light.png) ![TextButton dark](images/button_text_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsTextButton` composable:
 
@@ -127,18 +136,14 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Outlined button
 
 Outlined buttons are medium-emphasis buttons. They contain actions that are important, but aren’t
 the primary action in an app.
 
 ![ButtonOutlined](images/button_outlined_light.png) ![ButtonOutlined dark](images/button_outlined_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsOutlinedButton` composable:
 
@@ -163,18 +168,14 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Text toggle buttons group
 
 A group of text toggle buttons. Only one option in a group of toggle buttons can be selected and active at a time.
 Selecting one option deselects any other.
 
 ![Button text toggle group light](images/button_text_toggle_group_light.png) ![Button text toggle group dark](images/button_text_toggle_group_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsTextToggleButtonsRow` composable:
 
@@ -204,18 +205,14 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Icon button
 
 An icon button is a clickable icon, used to represent actions. This component is typically used
 inside an App Bar for the navigation icon / actions.
 
 ![OdsIconButton](images/button_icon_light.png) ![OdsIconButton dark](images/button_icon_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsIconButton` composable:
 
@@ -240,18 +237,14 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` to be applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Icon toggle button
 
 An icon button with two states, for icons that can be toggled 'on' and 'off', such as a bookmark
 icon, or a navigation icon that opens a drawer.
 
 ![Button icon toggle light](images/button_icon_toggle_light.png) ![Button icon toggle dark](images/button_icon_toggle_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsIconToggleButton` composable:
 
@@ -280,10 +273,6 @@ Parameter | Default&nbsp;value | Description
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Icon toggle buttons group
 
 A group of toggle buttons. Only one option in a group of toggle buttons can be selected and active
@@ -292,7 +281,7 @@ Selecting one option deselects any other.
 
 ![Button icon toggle group light](images/button_icon_toggle_group_light.png) ![Button icon toggle group dark](images/button_icon_toggle_group_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 Use the `OdsIconToggleButtonsRow` composable:
 
@@ -325,11 +314,3 @@ Parameter | Default&nbsp;value | Description
 `modifier: Modifier` | `Modifier` | `Modifier` applied to the toggle buttons group
 `displaySurface: OdsDisplaySurface` | `OdsDisplaySurface.Default` | `OdsDisplaySurface` applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
 {:.table}
-
-#### XML implementation
-
-_Soon available_
-
-## Component specific tokens
-
-_Soon available_
diff --git a/docs/components/Cards.md b/docs/components/Cards.md
@@ -10,10 +10,17 @@ description: Cards contain content and actions about a single subject.
 * [Accessibility](#accessibility)
 * [Variants](#variants)
     * [Vertical image first card](#vertical-image-first-card)
+        * [Jetpack Compose](#jetpack-compose)
+            * [OdsVerticalImageFirstCard API](#odsverticalimagefirstcard-api)
     * [Vertical header first card](#vertical-header-first-card)
+        * [Jetpack Compose](#jetpack-compose-1)
+            * [OdsVerticalHeaderFirstCard API](#odsverticalheaderfirstcard-api)
     * [Small card](#small-card)
+        * [Jetpack Compose](#jetpack-compose-2)
+            * [OdsSmallCard API](#odssmallcard-api)
     * [Horizontal card](#horizontal-card)
-* [Component specific tokens](#component-specific-tokens)
+        * [Jetpack Compose](#jetpack-compose-3)
+            * [OdsHorizontalCard API](#odshorizontalcard-api)
 
 ---
 
@@ -39,7 +46,7 @@ This is a full width card containing elements arranged vertically with an image
 
 ![Vertical image first card light](images/card_vertical_image_first_light.png) ![Vertical image first card dark](images/card_vertical_image_first_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 In your composable screen you can use `OdsVerticalImageFirstCard` composable:
 
@@ -75,17 +82,13 @@ Parameter | Default&nbsp;value | Description
 `onClick: (() -> Unit)?` | `null` | Callback invoked on card click
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Vertical header first card
 
 This is a full width card containing elements arranged vertically with a header (thumbnail, title & subtitle) as first element.
 
 ![Vertical header first card light](images/card_vertical_header_first_light.png) ![Vertical header first card dark](images/card_vertical_header_first_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 In your composable screen you can use `OdsVerticalHeaderFirstCard` composable:
 
@@ -126,17 +129,13 @@ Parameter | Default&nbsp;value | Description
 `onClick: (() -> Unit)?` | `null` | Callback called on card click
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Small card
 
 This is a small card which takes the half screen width.
 
 ![CardSmall](images/card_small_light.png) ![CardSmall dark](images/card_small_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 You can add an `OdsSmallCard` composable in your screen to add a small card:
 
@@ -176,17 +175,13 @@ Parameter | Default&nbsp;value | Description
 `onClick: (() -> Unit)?` | `null` | Callback invoked on card click
 {:.table}
 
-#### XML implementation
-
-_Soon available_
-
 ### Horizontal card
 
 This is a full screen width card with an image on the side. The image can be displayed on the left or on the right.
 
 ![Horizontal card light](images/card_horizontal_light.png) ![Horizontal card dark](images/card_horizontal_dark.png)
 
-#### Jetpack Compose implementation
+#### Jetpack Compose
 
 In your screen you can use `OdsHorizontalCard` composable:
 
@@ -225,11 +220,3 @@ Parameter | Default&nbsp;value | Description
 `divider: Boolean` | `true` | Controls the divider display. If `true`, it will be displayed between the card content and the action buttons.
 `onClick: (() -> Unit)?` | `null` | Callback invoked on card click
 {:.table}
-
-#### XML implementation
-
-_Soon available_
-
-## Component specific tokens
-
-_Soon available_
diff --git a/docs/components/Checkboxes.md b/docs/components/Checkboxes.md
@@ -15,7 +15,8 @@ Use checkboxes to:
 * [Specifications references](#specifications-references)
 * [Accessibility](#accessibility)
 * [Implementation](#implementation)
-* [Component specific tokens](#component-specific-tokens)
+    * [Jetpack Compose](#jetpack-compose)
+        * [OdsCheckbox API](#odscheckbox-api)
 
 ---
 
@@ -59,6 +60,3 @@ Parameter | Default&nbsp;value | Description
 `enabled: Boolean` | `true` | Controls enabled state of the checkbox. When `false`, this checkbox will not be clickable.
 {:.table}
 
-## Component specific tokens
-
-_Soon available_