-
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 creates or migrates reference documentation to the Reference section as described in SHIP-0041.
Description
Create or migrate reference documentation. Ensure API documentation is generated from source code where possible. Include CRD specifications, CLI reference, and other reference materials.
The Reference section should contain:
- Full API specifications
- CRD reference documentation
- CLI command reference
- Configuration reference
- Generated documentation from source code (where applicable)
Acceptance Criteria
- Reference section structure created in
content/docs/reference/ - API documentation generated from source code (where applicable)
- CRD reference documentation complete
- CLI reference documentation complete
- All internal links updated to new paths
- Hugo aliases configured for redirects from old paths
- Reference documentation is accurate and up-to-date
Dependencies
- Blocks: Configure Hugo aliases (Issue 10)
- Blocked by: Audit and categorize existing documentation (Issue 3)
Technical Notes
- Review existing API generation tooling in
api-gen/directory - Ensure CRD documentation is generated from source code where possible
- CLI reference should be comprehensive and include all commands and flags
- Consider automating reference documentation generation as part of CI/CD
- Update all internal markdown links to point to new paths
- Configure Hugo aliases for any moved reference content
- Contributors should feel free to create sub-issues on this task for specific content to be migrated.
These sub-issues may be created after the audit task (Issue 3) is completed.
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