Skip to content

Commit e71f48a

Browse files
committed
docs: improve docs
1 parent dd9c96d commit e71f48a

File tree

7 files changed

+26
-23
lines changed

7 files changed

+26
-23
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,12 @@ const MyComponent = mock();
7676
- [`<Portal>`](./docs/en/Portal.md) and [`<Overlay>`](./docs/en/Overlay.md)
7777
- [`<FullScreen>`](./docs/en/FullScreen.md)
7878
- [`<Slider>`](./docs/en/Slider.md)
79-
- Side effects
79+
- [`<Audio>`](./docs/en/Audio.md) and [`<Video>`](./docs/en/Video.md)
80+
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md), `<Prompt>`, `<Confirm>`
81+
- [Side Effects](./docs/en/Side-effects.md)
8082
- [`<LocalStorage>`](./docs/en/LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
8183
- `<Title>`, `<Favicon>`
8284
- [`go()`](./docs/en/routing.md#go), `<Redirect>`, `<Link>`, [`<Sms>`](./docs/en/Sms.md), [`<Mailto>`](./docs/en/Mailto.md), and `<Tel>`
83-
- Generators
84-
- [`<Audio>`](./docs/en/Audio.md), [`<Video>`](./docs/en/Video.md), and `<Media>`
85-
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md), `<Prompt>`, `<Confirm>`
8685
- [Boundaries](./docs/en/Boundaries.md)
8786
- [`<BrowserOnly>`](./docs/en/BrowserOnly.md), [`<ServerOnly>`](./docs/en/ServerOnly.md), and [`<ElectronOnly>`](./docs/en/ElectronOnly.md)
8887
- [`<ErrorBoundary>`](./docs/en/ErrorBoundary.md) and [`withErrorBoundary()`](./docs/en/ErrorBoundary.md#witherrorboundary-hoc)

docs/en/Generators.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/en/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@
4141
- [`<CssVarsProvider>`](./cssvars.md), [`<CssVars>`](./cssvars.md#cssvars), [`withCssVars()`](./cssvars.md#withcssvars-hoc), and [`@withCssVars`](./cssvars.md#withcssvars-decorator)
4242
- [`<Router>`](./routing.md#router), [`<Route>`](./routing.md#route), [`withRoute()`](./routing.md#withroute), `@withRoute`, `go()`, and `<Go>`
4343
- [`<Translations>`](./translate.md#translations), [`<Translate>`](./translate.md#translate-or-t), [`<T>`](./translate.md#translate-or-t), [`withT()`](./translate.md#witht-hoc), and [`@withT`](./translate.md#witht-decorator)
44-
- Generators
45-
- [`<Audio>`](./Audio.md), [`<Video>`](./Video.md), and `<Media>`
46-
- [`<LocalStorage>`](./LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
44+
- [UI](./UI.md)
45+
- [`<Portal>`](./Portal.md) and [`<Overlay>`](./Overlay.md)
46+
- [`<FullScreen>`](./FullScreen.md)
47+
- [`<Slider>`](./Slider.md)
48+
- [`<Audio>`](./Audio.md) and [`<Video>`](./Video.md)
4749
- [`<Speak>`](./Speak.md), [`<Vibrate>`](./Vibrate.md), [`<Alert>`](./Alert.md), `<Prompt>`, `<Confirm>`
50+
- [Side Effects](./Side-effects.md)
51+
- [`<LocalStorage>`](./LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
52+
- `<Title>`, `<Favicon>`
4853
- [`go()`](./routing.md#go), `<Redirect>`, `<Link>`, [`<Sms>`](./Sms.md), [`<Mailto>`](./Mailto.md), and `<Tel>`
4954
- [Boundaries](./Boundaries.md)
5055
- [`<BrowserOnly>`](./BrowserOnly.md), [`<ServerOnly>`](./ServerOnly.md), and [`<ElectronOnly>`](./ElectronOnly.md)
5156
- [`<ErrorBoundary>`](./ErrorBoundary.md) and [`withErrorBoundary()`](./ErrorBoundary.md#witherrorboundary-hoc)
5257
- `<CacheBoundary>`
53-
- [UI](./UI.md)
54-
- [`<Portal>`](./Portal.md) and [`<Overlay>`](./Overlay.md)
55-
- [`<FullScreen>`](./FullScreen.md)
56-
- [`<Slider>`](./Slider.md)
57-
- `<Overlay>`
5858
- [CSS resets](./CSS-resets.md)
5959
- [`<CssResetEricMeyer>`](./reset/CssResetEricMeyer.md) and [`<CssResetEricMeyerCondensed>`](./reset/CssResetEricMeyerCondensed.md)
6060
- [`<CssResetMinimalistic>`](./reset/CssResetMinimalistic.md), [`<CssResetMinimalistic2>`](./reset/CssResetMinimalistic2.md), and [`<CssResetMinimalistic3>`](./reset/CssResetMinimalistic3.md)

docs/en/SUMMARY.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,24 @@
4949
* [CSS Variables](cssvars.md)
5050
* [Router](routing.md)
5151
* [Translations](translate.md)
52-
* [Generators](Generators.md)
52+
* [UI](UI.md)
53+
* [Portal](Portal.md)
54+
* [Overlay](Overlay.md)
55+
* [FullScreen](FullScreen.md)
56+
* [Slider](Slider.md)
5357
* [Audio](Audio.md)
5458
* [Video](Video.md)
55-
* [LocalStorage](LocalStorage.md)
5659
* [Speak](Speak.md)
5760
* [Vibrate](Vibrate.md)
5861
* [Alert](Alert.md)
5962
* [Sms](Sms.md)
6063
* [Mailto](Mailto.md)
64+
* [Side Effects](Side-effects.md)
65+
* [LocalStorage](LocalStorage.md)
6166
* [Boundaries](Boundaries.md)
6267
* [BrowserOnly](BrowserOnly.md)
6368
* [ServerOnly](ServerOnly.md)
6469
* [ElectronOnly](ElectronOnly.md)
65-
* [UI](UI.md)
66-
* [Portal](Portal.md)
67-
* [Overlay](Overlay.md)
68-
* [FullScreen](FullScreen.md)
69-
* [Slider](Slider.md)
7070
* [CSS resets](CSS-resets.md)
7171
* [CssResetEricMeyer](./reset/CssResetEricMeyer.md)
7272
* [CssResetEricMeyerCondensed](./reset/CssResetEricMeyerCondensed.md)

docs/en/Side-effects.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Side Effects
2+
3+
Components with side effects are ones that use global environment APIs to modify environment state.
4+
5+
- [`<LocalStorage>`](./LocalStorage.md) &mdash; saves and retrieves objects from `localStorage`.
6+

src/Audio/__story__/story.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import ShowDocs from '../../../.storybook/ShowDocs'
77

88
const src = 'https://www.soundhelix.com/examples/mp3/SoundHelix-Song-2.mp3';
99

10-
storiesOf('Generators/Audio', module)
10+
storiesOf('UI/Audio', module)
1111
.add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Audio.md')}))
1212
.add('Example', () =>
1313
<Audio autoPlay src={src}>{(audio) =>

src/Video/__story__/story.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import ShowDocs from '../../../.storybook/ShowDocs'
77

88
const src = 'http://dailym.ai/2rG7TBS';
99

10-
storiesOf('Generators/Video', module)
10+
storiesOf('UI/Video', module)
1111
.add('Documentation', () => h(ShowDocs, {md: require('../../../docs/en/Video.md')}))
1212
.add('Example', () =>
1313
<Video autoPlay style={{

0 commit comments

Comments
 (0)