Review HoloViz guides with AI
Take a changed option through the reader’s guide, its example notebook and the rendered page.
Review HoloViz guides with AI when a feature change leaves an example behind. Suppose a library adds a way to fix the colour scale across a series of panels. A gallery image may look perfectly plausible with either setting. The documentation skill helps your agent pick two datasets whose ranges are different enough for a reader to notice what the new control does.
Think about the reader’s next action before choosing where to make the edit. A first-time user may need one complete example in a tutorial. Someone looking up the option later needs its exact name in the reference. Open the rendered notebook to check the legend and labels at the size the site actually gives them.
What it does
- Choose whether a change belongs in an introductory tutorial, a how-to or a reference entry.
- Use contrasting values to make a subtle display option visible.
- Catch clipped legends and overlapping tick labels after building the docs.
- Match prose to the example a reader can actually run.
- Refresh a backend-specific thumbnail where the gallery expects one.
Install and use
- Open the HoloViz checkout and its Pixi environment, including the backend used by the example.
- Point the agent to the changed behaviour, the existing entry and the reader you have in mind.
- Build using the task defined by that project, then inspect the rendered examples and captions.
FAQ
Source
Made by HoloViz Dev. Original skill: documentation, published on GitHub under the BSD-3-Clause licence.
View on GitHub