Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,17 @@ As hvPlot uses notebooks for much of the documentation, this takes a little whil

A development version of hvPlot can be found [here](https://holoviz-dev.github.io/hvplot/). You can ask a maintainer if they want to make a dev release for your PR, but there is no guarantee they will say yes.

### Markdown docs and `llms.txt`
Comment thread
Azaya89 marked this conversation as resolved.

As part of `docs-build`, hvPlot also generates clean Markdown versions of its documentation together with an `llms.txt` index file that points AI assistants at the most relevant pages.

The build produces:

- `builtdocs/markdown/` - a Markdown rendering of the documentation
- `builtdocs/llms.txt` - an index of the most useful documentation pages for LLM-assisted development

See [Using hvPlot with an AI assistant](how_to/use_llms.md) for how to consume these docs with an AI assistant.

### Link to hvPlot objects

```md
Expand Down
12 changes: 12 additions & 0 deletions doc/how_to/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How-To Guides

How-to guides are practical, problem-oriented instructions that help you accomplish specific tasks with hvPlot. These guides assume you're already familiar with the basics and want to solve particular problems or achieve specific goals.

```{toctree}
:titlesonly:
:hidden:
:maxdepth: 2

use_llms

```
72 changes: 72 additions & 0 deletions doc/how_to/use_llms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Using hvPlot with an AI assistant

AI assistants (like Claude, GitHub Copilot, or OpenAI Codex) can write hvPlot code much more reliably when they have access to up-to-date, structured documentation instead of guessing from stale training data. This guide shows you how to give your assistant that context, either by pointing it at hvPlot's generated `llms.txt` and Markdown docs, or by installing the HoloViz Agent Skills.

## What you'll accomplish

By the end of this guide you'll be able to:

- Install the HoloViz skills so your assistant follows hvPlot best practices automatically
- Give your AI assistant a curated index of the most useful hvPlot documentation pages

## Prerequisites

- A python package installer like `pip` or `uv` if you want to install the skills
- An AI assistant that can read web content or local files (for example Claude, GitHub Copilot, or OpenAI Codex)

## Install the HoloViz skills

The [holoviz-skills](https://holoviz-dev.github.io/holoviz-skills/) repository provides a curated collection of [Agent Skills](https://www.anthropic.com/news/skills) for the HoloViz ecosystem, including hvPlot. Agent Skills are folders of instructions and references that teach an assistant how to work with a library correctly.

::::{tab-set}

:::{tab-item} uv

```bash
uvx holoviz-skills@latest install
```

:::

:::{tab-item} pip
```bash
pip install holoviz-skills
```

:::

::::

```bash
holoviz-skills install
Comment thread
Azaya89 marked this conversation as resolved.
Outdated
```

The `install` command auto-detects the AI tools on your machine. You can also target a specific tool, for example:

```bash
holoviz-skills install --claude-code
holoviz-skills install --copilot
```

You may need to restart your assistant so it picks up the newly installed skills.

## Point your assistant at the docs

hvPlot publishes a machine-friendly index of its documentation that your assistant can fetch directly.

1. Tell your assistant to fetch the index:

`https://hvplot.holoviz.org/en/docs/latest/llms.txt`

2. The index lists the most relevant pages and links to their Markdown versions under:

`https://hvplot.holoviz.org/en/docs/latest/markdown/`, for example, `https://hvplot.holoviz.org/en/docs/latest/markdown/tutorials/getting_started.md`

3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a plot you might have it read the Getting Started tutorial and the API reference page for the method you need. On its own, it will read the appropriate Markdown pages.

The Markdown pages are intentionally free of the navigation chrome, CSS, and JavaScript of the full HTML site, so they consume far fewer tokens and are easier for an assistant to parse.

## Which approach should I use?

- **Point your assistant at the docs** is a good fit for a one-off task or when you can't install packages, and it always reflects the latest published docs.
- **Install the HoloViz skills** gives your assistant packaged, opinionated guidance that works offline, but you need to update it as hvPlot evolves. Once the skills are installed, pointing to the Markdown docs should no longer be needed if you want your agent to be able to fetch the latest docs, as the skills already teach the agent how to do that.
1 change: 1 addition & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ align: center

Tutorials <tutorials/index>
User Guide <user_guide/index>
How-To Guides <how_to/index>
Gallery <gallery/index>
Reference <ref/index>
Developer Guide <developer_guide>
Expand Down