-
-
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.