docs: update documentation for deprecated components (#2479)

openedx · Aug 23, 2023 · 91f176b · 91f176b
1 parent f4cfffa
commit 91f176b
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 38 deletions.
diff --git a/src/CheckBoxGroup/README.md b/src/CheckBoxGroup/README.md
@@ -9,7 +9,7 @@ status: 'Deprecate Soon'
 designStatus: 'To Do'
 devStatus: 'To Do'
 notes: |
-  Refactor to use Input component and refresh checkbox designs
+  Replaced by Form.Checkbox and Form.CheckboxSet
 ---
 
 ## Basic Usage

diff --git a/src/InputSelect/README.md b/src/InputSelect/README.md
@@ -9,10 +9,10 @@ status: 'Deprecate Soon'
 designStatus: 'TBD'
 devStatus: 'To Do'
 notes: |
-  Replaced by Input and ValidationFormGroup
+  Replaced by Form.Control
 ---
 
-## basic usage
+## Basic usage
 
 ```jsx live
 <InputSelect
@@ -28,7 +28,7 @@ notes: |
 />
 ```
 
-## separate labels and values
+## Separate labels and values
 
 ```jsx live
 <InputSelect
@@ -46,7 +46,7 @@ notes: |
 />
 ```
 
-## separate option groups
+## Separate option groups
 
 ```jsx live
 <InputSelect
@@ -82,7 +82,7 @@ notes: |
 />
 ```
 
-## with validation
+## With validation
 
 ```jsx live
 <InputSelect
@@ -102,16 +102,16 @@ notes: |
 />
 ```
 
-## disabled usage
+## Disabled usage
 
 ```jsx live
 <InputSelect
   name="fruits"
   label="Fruits"
   aria-label="Fruits"
   value="strawberry"
-  options={['
-    apple',
+  options={[
+    'apple',
     'orange',
     'strawberry',
     'banana',
@@ -120,7 +120,7 @@ notes: |
 />
 ```
 
-## with disabled option
+## With disabled option
 
 ```jsx live
 <InputSelect

diff --git a/src/InputText/README.md b/src/InputText/README.md
@@ -9,22 +9,22 @@ status: 'Deprecate Soon'
 designStatus: 'TBD'
 devStatus: 'To Do'
 notes: |
-  Replaced by Input and ValidationFormGroup
+  Replaced by Form.Control
 ---
 
-## minimal usage
+## Minimal usage
 
 ```jsx live
 <InputText name="name" label="First Name" value="Foo Bar" />
 ```
 
-## read only
+## Read only
 
 ```jsx live
 <InputText name="inputState" label="Input State" value="Read Only" readOnly />
 ```
 
-## validation
+## Validation
 
 ```jsx live
 <InputText
@@ -45,7 +45,7 @@ notes: |
 />
 ```
 
-### validation with danger theme
+### Validation with danger theme
 
 ```jsx live
 <InputText
@@ -67,7 +67,7 @@ notes: |
 />
 ```
 
-### label as element
+### Label as element
 
 ```jsx live
 <InputText
@@ -77,7 +77,7 @@ notes: |
 />
 ```
 
-### focus test
+### Focus test
 
 ```jsx live
 class FocusInputWrapper extends React.Component {
@@ -118,7 +118,7 @@ class FocusInputWrapper extends React.Component {
 }
 ```
 
-### different textual input types
+### Different textual input types
 
 ```jsx live
 <form>
@@ -209,7 +209,7 @@ class FocusInputWrapper extends React.Component {
 </form>
 ```
 
-### price with step
+### Price with step
 
 ```jsx live
 <InputText
@@ -222,13 +222,13 @@ class FocusInputWrapper extends React.Component {
 />
 ```
 
-### displayed inline
+### Displayed inline
 
 ```jsx live
 <InputText name="username" label="Username" value="foobar" inline />
 ```
 
-### with input group addons
+### With input group addons
 
 ```jsx live
 <form>

diff --git a/src/RadioButtonGroup/README.md b/src/RadioButtonGroup/README.md
@@ -9,11 +9,10 @@ status: 'Deprecate Soon'
 designStatus: 'To Do'
 devStatus: 'To Do'
 notes: |
-  Refactor to use Input component
-  and refresh checkbox designs
+  Replaced by Form.Radio and From.RadioSet
 ---
 
-## unselected minimal usage
+## Unselected minimal usage
 
 ```jsx live
 <RadioButtonGroup
@@ -31,7 +30,7 @@ notes: |
 </RadioButtonGroup>
 ```
 
-## selected minimal usage
+## Selected minimal usage
 
 ```jsx live
 <RadioButtonGroup

diff --git a/src/Table/README.md b/src/Table/README.md
@@ -9,10 +9,10 @@ status: 'Deprecate soon'
 designStatus: 'TBD'
 devStatus: 'TBD'
 notes: |
-  Potentially does too much work. Consider if should be multiple components: Table, TableHeader, SortableTable, etc.
+  Replaced by DataTable
 ---
 
-## unstyled
+## Unstyled
 
 ```jsx live
 <Table
@@ -77,7 +77,7 @@ notes: |
 />
 ```
 
-## table-striped
+## Table-striped
 
 ```jsx live
 <Table
@@ -143,7 +143,7 @@ notes: |
 />
 ```
 
-## default heading
+## Default heading
 
 ```jsx live
 <Table
@@ -209,7 +209,7 @@ notes: |
 />
 ```
 
-## responsive
+## Responsive
 
 ```jsx live
 <Table
@@ -275,7 +275,7 @@ notes: |
 />
 ```
 
-## sortable
+## Sortable
 
 ```jsx live
 () => {
@@ -373,7 +373,7 @@ notes: |
 };
 ```
 
-## fixed
+## Fixed
 
 ```jsx live
 <Table
@@ -439,7 +439,7 @@ notes: |
 />
 ```
 
-## row header
+## Row header
 
 ```jsx live
 <Table

diff --git a/src/TextArea/README.md b/src/TextArea/README.md
@@ -9,10 +9,10 @@ status: 'Deprecate Soon'
 designStatus: 'TBD'
 devStatus: 'To Do'
 notes: |
-  Replaced by Input and ValidationFormGroup
+  Replaced by Form.Control
 ---
 
-## minimal usage
+## Minimal usage
 
 ```jsx live
 <TextArea
@@ -22,7 +22,7 @@ notes: |
 />
 ```
 
-## scrollable
+## Scrollable
 
 ```jsx live
 <TextArea
@@ -32,7 +32,7 @@ notes: |
 />
 ```
 
-## validation
+## Validation
 
 ```jsx live
 <TextArea
@@ -52,7 +52,7 @@ notes: |
 />
 ```
 
-## label as element
+## Label as element
 
 ```jsx live
 <TextArea