Skip to content

Commit 682ea31

Browse files
fix(docs): clean up links in docs (#525)
* fix(docs): clean up links in docs * fix(docs): fix typos * fix: doc updates Co-authored-by: Carolyn Moneymaker <[email protected]> --------- Co-authored-by: Carolyn Moneymaker <[email protected]>
1 parent b02fa72 commit 682ea31

File tree

29 files changed

+82
-76
lines changed

29 files changed

+82
-76
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The following is a set of guidelines for contributing to `@lightningjs/ui-compon
5757

5858
**Documentation**
5959

60-
- [See the README for setup help](../?path=/story/docs-read-me--page)
60+
- [See the README for setup help](?path=/docs/docs-read-me--docs)
6161
- [See Storybook for component docs with live examples](https://rdkcentral.github.io/Lightning-UI-Components/)
6262

6363
**Discuss on Slack**

LUI.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The team presented LUI 2.0 during an RDK Webinar. Please view the videos below f
2727
## Structure
2828

2929
LUI is a monorepo containing the following packages:
30+
3031
- @lightningjs/ui-components
3132
- @lightningjs/ui-components-test-utils
3233
- @lightningjs/ui-components-theme-base
@@ -63,7 +64,7 @@ Theming is a way to easily reskin or style components via a set of style propert
6364

6465
Each of the components references specific style properties that map back to a global style sheet, which we call a "theme." This is a similar concept as CSS for web components.
6566

66-
You can find our complete documentation on theming in our [Storybook here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/story/docs-theming-overview--page).
67+
You can find our complete documentation on theming in our [Storybook here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/docs/docs-theming-overview--docs).
6768

6869
### Capabilities of Theming
6970

@@ -84,6 +85,7 @@ You can find our complete documentation on theming in our [Storybook here](https
8485
### Theming Schema
8586

8687
Theme files consist of the following overarching properties:
88+
8789
- alpha (opacity)
8890
- animation (curves)
8991
- color
@@ -96,7 +98,7 @@ Theme files consist of the following overarching properties:
9698
- componentConfig
9799
- extensions
98100

99-
For more information on the properties that make up a **theme** file, check out our [Storybook here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/story/docs-theming-theme-properties--page).
101+
For more information on the properties that make up a **theme** file, check out our [Storybook here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/docs/docs-theming-theme-properties--docs).
100102

101103
#### Component Config
102104

@@ -107,35 +109,41 @@ The `componentConfig` object can take in key value pairs of component names to n
107109
The `style` object can be used to override the predetermined style properties of the given component type.
108110

109111
For example:
112+
110113
```js
111114
componentConfig: {
112115
ProgressBar: {
113-
style: { radius: 20 }
116+
style: {
117+
radius: 20
118+
}
114119
}
115120
}
116121
```
117122

118123
##### Tones
119124

120125
The `tone` property expects a string which will determine the default color palette to apply to a component. It should match one of the following:
126+
121127
- neutral (meant for use on dark backgrounds)
122128
- inverse (meant for use on light backgrounds)
123129
- brand (meant to call branded focus to an element)
124130

125131
When specified, these strings will override the default tone used by the component in our library to quickly change the appearance of the component.
126132

127133
For example:
134+
128135
```js
129136
componentConfig: {
130137
ProgressBar: {
131-
tone: 'brand'
138+
tone: 'brand';
132139
}
133140
}
134141
```
135142

136143
##### Modes
137144

138145
The `mode` property expects a string which will determine the default interaction state to apply to a component. By default, components are in the unfocused mode, but depending on the platform, can be switched into modes like:
146+
139147
- unfocused (default)
140148
- focused (the active component being interacted with)
141149
- disabled (when a user should not be able to interact with a component)
@@ -144,10 +152,11 @@ The `mode` property expects a string which will determine the default interactio
144152
- pressed (can change the style when a Button is clicked down versus hovered on)
145153

146154
For example:
155+
147156
```js
148157
componentConfig: {
149158
ProgressBar: {
150-
mode: 'disabled'
159+
mode: 'disabled';
151160
}
152161
}
153162
```
@@ -157,6 +166,7 @@ componentConfig: {
157166
The `styleConfig` object contains overrides for a component's `tone` and `mode` styles that will be applied when a component is switched into those tone or mode states.
158167

159168
For example:
169+
160170
```js
161171
componentConfig: {
162172
ProgressBar: {
@@ -174,4 +184,4 @@ componentConfig: {
174184

175185
#### Extensions
176186

177-
The `extensions` array supplies custom behavior to a component library. This is a way for developers to dynamically adjust component code without having to extend and create their own custom component. For more information on Extensions, check out our [documentation here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/story/docs-theming-extensions--page).
187+
The `extensions` array supplies custom behavior to a component library. This is a way for developers to dynamically adjust component code without having to extend and create their own custom component. For more information on Extensions, check out our [documentation here](https://rdkcentral.github.io/Lightning-UI-Components/?path=/docs/docs-theming-theme-properties--docs).

packages/@lightningjs/ui-components/src/components/Card/CardRadio.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ class Basic extends lng.Component {
5757

5858
### Properties
5959

60-
| name | type | required | default | description |
61-
| -------- | ---------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------- |
60+
| name | type | required | default | description |
61+
| -------- | ---------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------- |
6262
| radio | object | false | undefined | Object containing all properties supported in the [Radio component](?path=/docs/components-radio--docs) |
63-
| subtitle | string \| object | false | undefined | The text to be displayed in the subtitle section of the card. |
63+
| subtitle | string \| object | false | undefined | The text to be displayed in the subtitle section of the card. |
6464

6565
### Style Properties
6666

packages/@lightningjs/ui-components/src/components/Card/CardSection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ https://github.com/rdkcentral/Lightning-UI-Components/blob/develop/packages/%40l
3333
## Usage
3434

3535
`CardSection` can display a title and an icon. If an icon is being passed in, iconWidth and iconHeight will also have to be passed in for the icon to render. Additionally, a title can be passed in.
36-
`CardSection` extends [Card](?path=/docs/components-card--card)
36+
`CardSection` extends [Card](?path=/docs/components-card--docs)
3737

3838
```js
3939
import { CardSection } from '@lightningjs/ui-components';

packages/@lightningjs/ui-components/src/components/Card/CardTitle.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ https://github.com/rdkcentral/Lightning-UI-Components/blob/develop/packages/%40l
3333
## Usage
3434

3535
`CardTitle` can display both a title and a description if a title and description are passed in.
36-
`CardTitle` extends [Card](?path=/docs/components-card--card)
36+
`CardTitle` extends [Card](?path=/docs/components-card--docs)
3737

3838
```js
3939
import { CardTitle } from '@lightningjs/ui-components';

packages/@lightningjs/ui-components/src/components/Column/Column.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,7 @@ If both of those properties are enabled, `alwaysScroll` will take precedence ove
121121

122122
### Style Properties
123123

124-
The Column component shares a few of the same style properties as the ones listed in NavigationManager. For a detailed description, please refer to style properties section in the [NavigationManager component](?path=/docs/components-navigationmanager--docs)
125-
126-
scrollIndex: number
127-
itemSpacing: number
128-
itemTransition: <DocsLink id="lng.Transition" />
124+
The Column component shares the same style properties as the ones listed in NavigationManager. For a detailed description, please refer to style properties section in the [NavigationManager component](?path=/docs/components-navigationmanager--docs#style-properties)
129125

130126
### Child Item Properties
131127

packages/@lightningjs/ui-components/src/components/Column/Column.stories.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -600,15 +600,15 @@ LazyUpCount.argTypes = {
600600
lazyUpCount: {
601601
control: 'number',
602602
description:
603-
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/navigation-navigationmanager--row#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
603+
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/components-navigationmanager--docs#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
604604
table: {
605605
defaultValue: { summary: 'undefined' }
606606
}
607607
},
608608
lazyUpCountBuffer: {
609609
control: 'number',
610610
description:
611-
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/navigation-navigationmanager--row#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
611+
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/components-navigationmanager--docs#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
612612
table: {
613613
defaultValue: { summary: 2 }
614614
}
@@ -708,15 +708,15 @@ AddingItems.argTypes = {
708708
lazyUpCount: {
709709
control: 'number',
710710
description:
711-
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/navigation-navigationmanager--row#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
711+
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/components-navigationmanager--docs#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
712712
table: {
713713
defaultValue: { summary: 'undefined' }
714714
}
715715
},
716716
lazyUpCountBuffer: {
717717
control: 'number',
718718
description:
719-
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/navigation-navigationmanager--row#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
719+
'Used to calculate the number of items to display on the first render, see [Docs](?path=/docs/components-navigationmanager--docs#properties) for more details. <br/> **NOTE: changing this value requires refreshing the story to see its effect.**',
720720
table: {
721721
defaultValue: { summary: 2 }
722722
}

packages/@lightningjs/ui-components/src/components/Control/Control.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Optional flag for the `Control` element to collapse (hide the title) when `Contr
7979

8080
### Style Properties
8181

82-
`Control` contains the same style properties as [Button](?path=/docs/components-button--docs) in additional to a couple other style properties listed below:
82+
`Control` contains the same style properties as [Button](?path=/docs/components-button--docs) in addition to a couple other style properties listed below:
8383

8484
| name | type | description |
8585
| --------- | ------ | ----------------------------------- |

packages/@lightningjs/ui-components/src/components/ControlRow/ControlRow.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import * as ControlRowStories from './ControlRow.stories';
2525
<Title />
2626

2727
The `ControlRow` component renders a
28-
[TitleRow](/docs/components-titlerow--basic) component with optional left controls content items, and right controls
28+
[TitleRow](?path=/docs/components-titlerow--docs) component with optional left controls content items, and right controls
2929
which are rendered as row items in that order.
3030

3131
## Source
@@ -34,7 +34,7 @@ https://github.com/rdkcentral/Lightning-UI-Components/blob/develop/packages/@lig
3434

3535
## Usage
3636

37-
`ControlRow` accepts all [properties supported by TitleRow](/docs/components-titlerow--basic#properties)
37+
`ControlRow` accepts all [properties supported by TitleRow](?path=/docs/components-titlerow--docs#properties)
3838
as well as optional `leftControls`, `contentItems`, and `rightControls` properties.
3939

4040
```js
@@ -99,7 +99,7 @@ class LazyLoad extends lng.Component {
9999

100100
### Properties
101101

102-
**`ControlRow` is a subclass of the [`TitleRow`](/docs/components-titlerow--basic)**,
102+
**`ControlRow` is a subclass of the [`TitleRow`](?path=/docs/components-titlerow--docs)**,
103103
so allows setting all properties that are available on `TitleRow`.
104104

105105
| name | type | required | default | description |

packages/@lightningjs/ui-components/src/components/Keyboard/Keyboard.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ All of the following examples will yield the same result.
9898
| defaultFormat | string | true | undefined | default format of the keyboard to be shown. should be a key of `formats`. |
9999
| formats | object | true | undefined | object containing arrays that represent different formats that the keyboard can be presented in. These arrays can contain strings or objects. |
100100
| inline | boolean | false | false | if the keyboard is an inline keyboard and can ignore row/column count requirements |
101-
| input | object | true | undefined | object with all of the properties for [Input](?path=/docs/components-input--input) |
101+
| input | object | true | undefined | object with all of the properties for [Input](?path=/docs/components-input--docs) |
102102
| keyComponent | lng.Component | false | Key | component to display for each key |
103103
| rowCount | number | false | undefined | number of rows down the keyboard if passing a flat array |
104104
| rowWrap | boolean | false | true | wrap keyboard rows when navigating left and right |

0 commit comments

Comments
 (0)