From 66d24bf8902c3046109ce44708e19a1e0b49cc7a Mon Sep 17 00:00:00 2001 From: Isaiah Akorita Date: Wed, 19 Aug 2026 14:11:06 +0100 Subject: [PATCH 1/5] document markdown docs and llms.txt --- doc/developer_guide/index.md | 11 +++++++ doc/how_to/index.md | 1 + doc/how_to/use_llms.md | 61 ++++++++++++++++++++++++++++++++++++ 3 files changed, 73 insertions(+) create mode 100644 doc/how_to/use_llms.md diff --git a/doc/developer_guide/index.md b/doc/developer_guide/index.md index b87442e587e..59bd65b1705 100644 --- a/doc/developer_guide/index.md +++ b/doc/developer_guide/index.md @@ -254,6 +254,17 @@ To be able to run cells interactively you need `pyodide` server, this can be run pixi run docs-server ``` +### Markdown docs and `llms.txt` + +As part of `docs-build`, Panel 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 Panel with an AI assistant](../how_to/use_llms.md) for how to consume these docs with an AI assistant. + ## Build Panel has four build tasks, for building packages for Pip, Conda, Pyodide, and NPM. diff --git a/doc/how_to/index.md b/doc/how_to/index.md index c771af17227..baeee18e118 100644 --- a/doc/how_to/index.md +++ b/doc/how_to/index.md @@ -308,4 +308,5 @@ test_and_debug prepare_to_share share_your_work migrate_to_panel +use_llms ``` diff --git a/doc/how_to/use_llms.md b/doc/how_to/use_llms.md new file mode 100644 index 00000000000..b14101d9d41 --- /dev/null +++ b/doc/how_to/use_llms.md @@ -0,0 +1,61 @@ +# Using Panel with an AI assistant + +AI assistants (like Claude, GitHub Copilot, or OpenAI Codex) can write Panel 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 Panel'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 Panel documentation pages +- Install the HoloViz skills so your assistant follows Panel best practices automatically + +## Prerequisites + +- An AI assistant that can read web content or local files (for example Claude, GitHub Copilot, or OpenAI Codex) +- [Python](https://www.python.org/) 3.12+ and `pip` if you want to install the skills + +## Point your assistant at the docs + +Panel publishes a machine-friendly index of its documentation that your assistant can fetch directly. + +1. Tell your assistant to fetch the index: + + `https://panel.holoviz.org/llms.txt` + +2. The index lists the most relevant pages and links to their Markdown versions under: + + `https://panel.holoviz.org/markdown/` + +3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a dashboard you might have it read `tutorials/basic/build_dashboard.md` and the reference page for the method you need. + +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. + +## 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 Panel. 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 + ``` + +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. + +## 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 Panel evolves. From 450b9ce7c6ba3a6131ce0ce129ab40a75aac8fc8 Mon Sep 17 00:00:00 2001 From: Isaiah Akorita Date: Wed, 19 Aug 2026 19:39:00 +0100 Subject: [PATCH 2/5] tighten --- doc/how_to/use_llms.md | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/doc/how_to/use_llms.md b/doc/how_to/use_llms.md index b14101d9d41..4bec40fd3a2 100644 --- a/doc/how_to/use_llms.md +++ b/doc/how_to/use_llms.md @@ -12,23 +12,7 @@ By the end of this guide you'll be able to: ## Prerequisites - An AI assistant that can read web content or local files (for example Claude, GitHub Copilot, or OpenAI Codex) -- [Python](https://www.python.org/) 3.12+ and `pip` if you want to install the skills - -## Point your assistant at the docs - -Panel publishes a machine-friendly index of its documentation that your assistant can fetch directly. - -1. Tell your assistant to fetch the index: - - `https://panel.holoviz.org/llms.txt` - -2. The index lists the most relevant pages and links to their Markdown versions under: - - `https://panel.holoviz.org/markdown/` - -3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a dashboard you might have it read `tutorials/basic/build_dashboard.md` and the reference page for the method you need. - -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. +- A python package installer like `pip` or `uvx` if you want to install the skills ## Install the HoloViz skills @@ -40,6 +24,12 @@ The [holoviz-skills](https://holoviz-dev.github.io/holoviz-skills/) repository p pip install holoviz-skills ``` + OR + + ```bash + uvx install holoviz-skills + ``` + 2. Install the skills for your tool: ```bash @@ -55,6 +45,23 @@ The [holoviz-skills](https://holoviz-dev.github.io/holoviz-skills/) repository p 3. Restart your assistant so it picks up the newly installed skills. +## Point your assistant at the docs + +Panel publishes a machine-friendly index of its documentation that your assistant can fetch directly. + +1. Tell your assistant to fetch the index: + + `https://panel.holoviz.org/llms.txt` + +2. The index lists the most relevant pages and links to their Markdown versions under: + + `https://panel.holoviz.org/markdown/` + +3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a dashboard you might have it read `tutorials/basic/build_dashboard.md` and the reference page for the method you need. + +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. From 010151eaf5bb357bb531e054b1ba19f2ca2af283 Mon Sep 17 00:00:00 2001 From: Isaiah Akorita Date: Thu, 20 Aug 2026 13:00:03 +0100 Subject: [PATCH 3/5] small touches --- doc/how_to/use_llms.md | 51 +++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/doc/how_to/use_llms.md b/doc/how_to/use_llms.md index 4bec40fd3a2..1e6c1a0501d 100644 --- a/doc/how_to/use_llms.md +++ b/doc/how_to/use_llms.md @@ -6,44 +6,49 @@ AI assistants (like Claude, GitHub Copilot, or OpenAI Codex) can write Panel cod By the end of this guide you'll be able to: -- Give your AI assistant a curated index of the most useful Panel documentation pages - Install the HoloViz skills so your assistant follows Panel best practices automatically +- Give your AI assistant a curated index of the most useful Panel 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 +- 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 Panel. Agent Skills are folders of instructions and references that teach an assistant how to work with a library correctly. -1. Install the package: +::::{tab-set} + +:::{tab-item} uv + +```bash +uvx holoviz-skills@latest install +``` - ```bash - pip install holoviz-skills - ``` +::: - OR +:::{tab-item} pip +```bash +pip install holoviz-skills +``` - ```bash - uvx install holoviz-skills - ``` +::: -2. Install the skills for your tool: +:::: - ```bash - holoviz-skills install - ``` +```bash +holoviz-skills install +``` - This auto-detects the AI tools on your machine. You can also target a specific tool, for example: +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 - ``` +```bash +holoviz-skills install --claude-code +holoviz-skills install --copilot +``` -3. Restart your assistant so it picks up the newly installed skills. +You may need to restart your assistant so it picks up the newly installed skills. ## Point your assistant at the docs @@ -55,9 +60,9 @@ Panel publishes a machine-friendly index of its documentation that your assistan 2. The index lists the most relevant pages and links to their Markdown versions under: - `https://panel.holoviz.org/markdown/` + `https://panel.holoviz.org/markdown/`, for example `https://panel.holoviz.org/markdown/tutorials/basic/build_dashboard.md` -3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a dashboard you might have it read `tutorials/basic/build_dashboard.md` and the 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 dashboard you might have it read the Build a Dashboard tutorial and the reference page for the method you need. 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. @@ -65,4 +70,4 @@ The Markdown pages are intentionally free of the navigation chrome, CSS, and Jav ## 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 Panel evolves. +- **Install the HoloViz skills** gives your assistant packaged, opinionated guidance that works offline, but you need to update it as Panel 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. From e95bceadd22098152d8aad9969a1d2172c561218 Mon Sep 17 00:00:00 2001 From: Isaiah Akorita Date: Thu, 20 Aug 2026 17:01:03 +0100 Subject: [PATCH 4/5] final --- doc/how_to/use_llms.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/how_to/use_llms.md b/doc/how_to/use_llms.md index 1e6c1a0501d..369bf9293ea 100644 --- a/doc/how_to/use_llms.md +++ b/doc/how_to/use_llms.md @@ -31,16 +31,13 @@ uvx holoviz-skills@latest install :::{tab-item} pip ```bash pip install holoviz-skills +holoviz-skills install ``` ::: :::: -```bash -holoviz-skills install -``` - The `install` command auto-detects the AI tools on your machine. You can also target a specific tool, for example: ```bash @@ -66,7 +63,6 @@ Panel publishes a machine-friendly index of its documentation that your assistan 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. From c2442820a80100b7f650ca326e64205a24119993 Mon Sep 17 00:00:00 2001 From: Isaiah Akorita Date: Fri, 21 Aug 2026 15:20:17 +0100 Subject: [PATCH 5/5] adjust order --- doc/how_to/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/how_to/index.md b/doc/how_to/index.md index baeee18e118..7e5c5a07668 100644 --- a/doc/how_to/index.md +++ b/doc/how_to/index.md @@ -301,6 +301,7 @@ How to convert AnyWidget widgets to Panel widgets. prepare_to_develop build_apps +use_llms use_specialized_uis manage_session_tasks extending_panel @@ -308,5 +309,4 @@ test_and_debug prepare_to_share share_your_work migrate_to_panel -use_llms ```