Skip to content

docs: complete documentation section in philosophy.md #3800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
njg7194 wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −1
Open

docs: complete documentation section in philosophy.md #3800

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion philosophy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,15 @@ Our goal is to create a well-funded open-source component library that the commu

### Documentation

TODO
- Documentation should be comprehensive yet concise, explaining the "why" behind design decisions
- Every component should have clear examples demonstrating common use cases
- API references should include type information, default values, and accessibility notes
- Include migration guides when introducing breaking changes
- Provide copy-pasteable code snippets that work out of the box
- Document known limitations and edge cases transparently
- Keep examples focused on one concept at a time to reduce cognitive load
- Include interactive playgrounds where possible for hands-on exploration
- Accessibility documentation should explain both what the component does automatically and what the developer is responsible for

### Misc

Expand Down