-
-
Notifications
You must be signed in to change notification settings - Fork 123
Document markdown docs and llms.txt addition #1751
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||
|
|
||
| ``` |
| 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 | ||
|
Azaya89 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## 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 | ||
|
Azaya89 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do I need to explicitly "call" the skills in my coding agent (
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Azaya89 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## 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/` | ||
|
Azaya89 marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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. | ||
|
Azaya89 marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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. | ||
|
Azaya89 marked this conversation as resolved.
Outdated
Azaya89 marked this conversation as resolved.
Outdated
|
||
Uh oh!
There was an error while loading. Please reload this page.