-
Notifications
You must be signed in to change notification settings - Fork 30
Open
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Description
Overview
This task updates CONTRIBUTING.md and related documentation to reflect the new documentation structure and contribution process as described in SHIP-0041.
Description
Update CONTRIBUTING.md and related documentation to reflect the new documentation structure and contribution process. Clarify that docs should be submitted via PRs to the website repository, not in-tree documentation.
The updated guidelines should:
- Explain the new documentation structure (Quick Start, Concepts, How To, Reference)
- Provide guidance on which section to use for different types of content
- Document the contribution process
- Include examples for each documentation type
Acceptance Criteria
- CONTRIBUTING.md updated with new structure
- Documentation types (Concepts, How To, Reference) explained
- Contribution process documented (PRs to website repository)
- Examples provided for each documentation type
- Guidelines reviewed by documentation maintainers
Dependencies
- Blocks: None
- Blocked by: None (can be done in parallel with migration tasks)
Technical Notes
- Review existing CONTRIBUTING.md to understand current structure
- Add section explaining the four documentation types
- Provide clear examples of each documentation type
- Document the PR process for documentation contributions
- Consider adding a documentation template or checklist
Generated-by: Cursor
Metadata
Metadata
Assignees
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Type
Projects
Status
No status