Documentation

Documentation guidelines for HoloViz packages. Use when writing or reviewing docs, changelog entries, or API references in any HoloViz repository. Use when this capability is needed.

tomevault-io Updated

File contents

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.toml for the task (e.g. pixi run docs-build).

Source: holoviz-dev/holoviz-skills — distributed by TomeVault.

tomevault-io/skills-registry/tree/main/holoviz-dev--holoviz-skills--documentation commit 31b5ec5d75

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-73