Documentation¶
This skill covers documentation expectations when contributing to HoloViz repositories.
Most HoloViz projects follow the Diátaxis documentation framework (tutorials, how-to guides, explanation, reference). Place new docs in the appropriate category. If the project doesn't follow Diátaxis yet, match the existing structure.
Docs Coverage¶
- New features and enhancements must be documented. A PR that adds a parameter, method, or behavior change without updating docs is incomplete.
- Build docs via pixi. Check
pixi.tomlfor the task (e.g.pixi run docs-build).