docs: complete documentation section in philosophy.md#3800
Open
njg7194 wants to merge 1 commit intoradix-ui:mainfrom
Open
docs: complete documentation section in philosophy.md#3800njg7194 wants to merge 1 commit intoradix-ui:mainfrom
njg7194 wants to merge 1 commit intoradix-ui:mainfrom
Conversation
Filled in the TODO section for Documentation principles with guidelines for: - Comprehensive yet concise documentation - Clear examples for common use cases - API references with type info and accessibility notes - Migration guides for breaking changes - Interactive playgrounds for exploration - Transparent documentation of limitations These principles align with the existing philosophy around developer experience and accessibility.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completed the
TODOplaceholder in the Documentation section ofphilosophy.md.Changes
Added documentation principles that align with the existing philosophy:
Motivation
The philosophy document establishes important guiding principles for Radix Primitives. Having the Documentation section filled in helps contributors and maintainers understand the expected standards for component documentation.
These guidelines are especially relevant given the accessibility-first approach of Radix, where clear documentation of accessibility features is crucial.