DNNCommunity / DNNCommunity/dnn-elements
Improve `Usage` documentation for all components
- Dominant language
- TypeScript
- Stars
- 19
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Improve `Usage` documentation for all components. Within StencilJS is a convention for documentation that allows individual usage examples to be located within a `usage` folder for each component. The file name is used as a title for each example within the `Usage` section of the component auto-generated portion of the `readme.md`. For now, we can stick with the following two usage example filenames:
* HTML.md
* JSX-TSX.md
Using ALL CAPS seems to keep the titles from translating to Title Case.
```[tasklist]
### Tasks
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1000
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1001
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1002
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1003
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1005
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1006
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1009
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1010
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1011
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1012
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1013
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1014
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1026
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1027
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1028
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1029
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1030
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1031
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1004
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1032
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1033
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1034
- [ ] https://github.com/DNNCommunity/dnn-elements/issues/1035
```
Contributor guide
Assessment
This issue has not been assessed yet.