daffodil
daffodil copied to clipboard
[DOCS] Docs describing the API, utilization and examples of the `@daffodil` libraries
:page_facing_up: Documentation Request
What were you doing?
I was trying to utilize any of the @daffodil
packages.
Expected behavior
I would like to be able to quickly learn how to utilize the @daffodil
libraries.
Existing Documentation
There isn't any, that's the issue.
Areas that need documentation coverage (Ideas List)
- [ ] Overview
- [ ] What's New
- [ ] Getting Started
- [ ] Planning/Installing
- [ ] Maintaining/Troubleshooting
- [ ] Resources
- [ ] Tutorial: Sticker Shop
- [ ] Architecture
- [ ] Platform Independence
- [ ] Redux Patterns
- [ ] Glossary
- [ ]
@daffodil/design
(#2767)- [x] SCSS Usage Examples
- [ ] SCSS API
- [ ] SCSS Tutorials
- [ ] Theming Guides
- [ ] Accessibility
- [ ] Component
- [ ] Overview
- [ ] Examples
- [ ]
@daffodil/product
- [ ] Usage Examples
- [ ] Tutorials/Guides
- [ ] API Documentation
- [ ]
@daffodil/core
- [ ] Usage Examples
- [ ] Tutorials/Guides
- [ ] API Documentation
- [ ]
@daffodil/checkout
- [ ] Usage Examples
- [ ] Tutorials/Guides
- [ ] API Documentation
- [ ]
@daffodil/cart
- [ ] Usage Examples
- [ ] Tutorials/Guides
- [ ] API Documentation
For those looking to do some Hacktoberfest PRs, we have a docs site that is an Angular app generated with dgeni, but it doesn't look fantastic and the docs are very incomplete. This is a great first issue and a good source of Hacktoberfest PR count!
We should review https://documentation.divio.com/