Release date: Mid-April 2020
🚁 Targets
- High quality and well-written documentation.
- Beginner friendly, yet surgically accurate documentation for advanced users.
- Good test coverage;
- Accessibility support for all components.
- Accessibility report documentation for all components.
- Codesandbox examples for each component.
- SEO support for docs
📗 Documentation
- Beginner friendly: All component docs should be consumable by any Vue beginner user. This means only the use of simple but comprehensive language. 😁
- Copiable Snippets: All components should have snippets that the user can copy if they's like to quickly test a component.
- Props Table: All components should have a full, concise props table highlighting each component's props and accepted values.
- Accessibility: Each component docs should link to its respective
accessibility.md
report to explain in detail how this component is accessible. Further explanation can be linked to the WAI-ARIA official site for that component.
- Codesandbox Examples: Each component should have a link to a codesandbox for users who would like to try out more complex things with that example.
- Internationalization: Since we expect users from China and other non-English-speaking countries to use Chakra UI, all components should also be documented in other languages too. (Please let me know if you're willing to contribute! ❤️)
- Frequently Asked Questions: If there are any known issues about a given component, highlight them at the bottom of the component page after the props table.