Overview
This task updates maintainer guidelines to require documentation for all features, either via generated reference content or manual documentation in the website repository as described in SHIP-0041.
Description
Update maintainer guidelines to require documentation for all features, either via generated reference content or manual documentation in the website repository. Document the process for ensuring docs are included in feature PRs.
The updated guidelines should:
- Require documentation for all new features
- Specify that documentation should be in the website repository (not in-tree)
- Provide guidance on minimum documentation requirements
- Document the review process for documentation
Acceptance Criteria
Dependencies
- Blocks: None
- Blocked by: None (can be done in parallel with migration tasks)
Technical Notes
- Review existing maintainer guidelines in
shipwright-io/community repository
- Add section on documentation requirements
- Specify that documentation PRs should be linked from feature PRs
- Consider adding documentation checklist to PR template
- Coordinate with maintainers to ensure requirements are reasonable
Generated-by: Cursor
Overview
This task updates maintainer guidelines to require documentation for all features, either via generated reference content or manual documentation in the website repository as described in SHIP-0041.
Description
Update maintainer guidelines to require documentation for all features, either via generated reference content or manual documentation in the website repository. Document the process for ensuring docs are included in feature PRs.
The updated guidelines should:
Acceptance Criteria
Dependencies
Technical Notes
shipwright-io/communityrepositoryGenerated-by: Cursor