What
Document the contributor workflow for API documentation.
Add contributor-facing documentation that explains how to build, preview, version, and troubleshoot the generated API docs.
Why
The API docs pipeline will only remain useful if future contributors can run and maintain it. Clear workflow documentation reduces maintainer burden and helps reviewers understand what local and CI commands are expected to do.
This also provides the handoff material needed after the initial GSoC implementation.
How
Write a practical contributor guide for the API docs pipeline.
The update should:
- document how to build Python API docs locally
- document how to build Rust API docs locally and note toolchain limitations
- document how to preview the API Reference section in Docusaurus
- document CI/preview artifact expectations and common troubleshooting steps
- document the versioning workflow once the release policy is agreed
Out of scope:
- implementing new docs generator features
- changing CI behavior beyond documenting it
- rewriting unrelated contributor documentation
- changing runtime API behavior
Parent roadmap: #1361
What
Document the contributor workflow for API documentation.
Add contributor-facing documentation that explains how to build, preview, version, and troubleshoot the generated API docs.
Why
The API docs pipeline will only remain useful if future contributors can run and maintain it. Clear workflow documentation reduces maintainer burden and helps reviewers understand what local and CI commands are expected to do.
This also provides the handoff material needed after the initial GSoC implementation.
How
Write a practical contributor guide for the API docs pipeline.
The update should:
Out of scope:
Parent roadmap: #1361