Skip to content
Open
Show file tree
Hide file tree
Changes from all 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

```
67 changes: 67 additions & 0 deletions doc/how_to/use_llms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 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:

- Give your AI assistant a curated index of the most useful hvPlot documentation pages
- Install the HoloViz skills so your assistant follows hvPlot best practices automatically
Comment on lines +9 to +10

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Give your AI assistant a curated index of the most useful hvPlot documentation pages
- Install the HoloViz skills so your assistant follows hvPlot best practices automatically
- 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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- An AI assistant that can read web content or local files (for example Claude, GitHub Copilot, or OpenAI Codex)
- A python package installer like `pip` or `uvx` if you want to install the skills
- 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.

1. Install the package:

```bash
pip install holoviz-skills
```

OR

```bash
uvx install holoviz-skills
```

2. Install the skills for your tool:

```bash
holoviz-skills install
```

This 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
```

3. Restart your assistant so it picks up the newly installed skills.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I need to explicitly "call" the skills in my coding agent (/holoviz-skills bla bla)? If not, are there specific keywords I should include in my prompt? Like should I prompt "make this plot with hvplot", or is "make this plot" enough?

@Azaya89 Azaya89 Aug 19, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have the skills installed, you don't have to explicitly call it but you may have to also say "...with hvplot" for it to automatically use the skills. But I think @ahuang11 can say more about that.

Comment on lines +21 to +46

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uvx doesn't work the way you suggested. It doesn't install the tool on your path. To get it on the path, you need to use uv tool install. See https://pydevtools.com/handbook/explanation/when-to-use-uv-run-vs-uvx/#when-should-you-use-uvx. uvx is appropriate in this context imo, as, as a user, I don't want to have the holoviz-skills CLI permanently available, as it's really only meant to be used once.

Suggested change
1. Install the package:
```bash
pip install holoviz-skills
```
OR
```bash
uvx install holoviz-skills
```
2. Install the skills for your tool:
```bash
holoviz-skills install
```
This 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
```
3. Restart your assistant so it picks up the newly installed skills.
::::{tab-set}
:::{tab-item} uv
```bash
uvx holoviz-skills@latest install
```
:::
:::{tab-item} pip
```bash
pip install holoviz-skills
holoviz-skills install
```
::::
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/`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`https://hvplot.holoviz.org/en/docs/latest/markdown/`
`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 `tutorials/getting_started.md` and the API reference page for the method you need.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 `tutorials/getting_started.md` and the API reference page for the method you need.
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the skill point the AI to the markdown docs?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, and to the llms.txt file as well.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Worth being mentioned?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already planned to be mentioned in the holoviz-skills docs. For example, for PMUi https://github.com/holoviz-dev/holoviz-skills/blob/main/developing-with-holoviz/skills/panel/using-material-ui.md?plain=1#L29

After this PR is merged, we'll do the same for the hvPlot section as well in the skills repo. So I dunno if we need to mention it here again.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I understand that when the skill is installed, then users can ignore the other section.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Install the HoloViz skills** gives your assistant packaged, opinionated guidance that works offline, but you need to update it as hvPlot evolves.
- **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