What
Iterate on the API documentation user experience based on feedback.
Collect feedback from representative users and contributors, then improve the structure, wording, and navigation of the generated API Reference section.
Why
Generated API docs are only useful if users can find and understand the relevant APIs. Feedback from ML practitioners, quant users, and contributors can reveal navigation gaps or confusing generated output that implementation-focused issues may miss.
This issue keeps UX feedback visible as a first-class part of the documentation pipeline.
How
Gather and apply focused feedback on the generated API docs experience.
The update should:
- collect feedback from representative users or contributors
- evaluate discoverability, navigation, and page readability for Python and Rust API docs
- prioritize concrete UX improvements
- apply small wording or structure improvements where appropriate
- record follow-up tasks for larger generator or website changes
Out of scope:
- major generator rewrites unless required by feedback
- release/tag automation
- unrelated website redesign work
- changing API behavior
Parent roadmap: #1361
What
Iterate on the API documentation user experience based on feedback.
Collect feedback from representative users and contributors, then improve the structure, wording, and navigation of the generated API Reference section.
Why
Generated API docs are only useful if users can find and understand the relevant APIs. Feedback from ML practitioners, quant users, and contributors can reveal navigation gaps or confusing generated output that implementation-focused issues may miss.
This issue keeps UX feedback visible as a first-class part of the documentation pipeline.
How
Gather and apply focused feedback on the generated API docs experience.
The update should:
Out of scope:
Parent roadmap: #1361