Skip to content

docs: serve an llms.txt index of the documentation - #1939

Draft
ghostiee-11 wants to merge 4 commits into
holoviz:mainfrom
ghostiee-11:add/llms-txt
Draft

docs: serve an llms.txt index of the documentation#1939
ghostiee-11 wants to merge 4 commits into
holoviz:mainfrom
ghostiee-11:add/llms-txt

Conversation

@ghostiee-11

Copy link
Copy Markdown
Collaborator

LLM assistants now handle a large share of the "which library should I use for this" questions that used to go to search, and they read a site far better when it publishes a curated index than when they have to crawl it. llms.txt is the convention for that. marimo and Vizro both serve one. No HoloViz site does.

This adds docs/llms.txt.

Zensical copies static files from docs/ to the site root, so this needs no build changes. A test keeps the link list in sync with the pages that actually exist.
@codecov

codecov Bot commented Jul 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.37%. Comparing base (733acbb) to head (2eafabc).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1939      +/-   ##
==========================================
+ Coverage   72.32%   72.37%   +0.04%     
==========================================
  Files         203      204       +1     
  Lines       35666    35714      +48     
==========================================
+ Hits        25796    25848      +52     
+ Misses       9870     9866       -4     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ahuang11

Copy link
Copy Markdown
Contributor

Let's wait for https://github.com/holoviz/hvplot/pull/1732/changes to settle

@ahuang11
ahuang11 marked this pull request as draft July 21, 2026 22:41
@ghostiee-11

Copy link
Copy Markdown
Collaborator Author

Okay!!

ghostiee-11 and others added 2 commits July 24, 2026 22:41
Replaces the hand-written docs/llms.txt with a build step, following the
approach in holoviz/hvplot#1732. The zensical nav is the single source of
truth, so pages and labels can never drift from the site, and the linked
markdown is mirrored under /markdown so an LLM can fetch the prose
without parsing the rendered HTML.
@ghostiee-11
ghostiee-11 marked this pull request as ready for review July 24, 2026 17:20
@ghostiee-11
ghostiee-11 requested a review from ahuang11 July 24, 2026 17:22
The tutorials index links seven tutorials but the nav only carried four,
so the rest were published without a sidebar entry and were skipped by
llms.txt, which is generated from the nav. Labels match the index page.
@ghostiee-11
ghostiee-11 requested a review from philippjfr July 27, 2026 12:44
@ahuang11

Copy link
Copy Markdown
Contributor

Do you have an example artifact I can look at

@ghostiee-11

Copy link
Copy Markdown
Collaborator Author

lumen-llms.txt

pr1939-markdown-mirror

@ahuang11

ahuang11 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor
> Lumen is an open-source and extensible agent framework for chatting with data and for retrieval augmented generation. It turns natural language into SQL, data transformation pipelines, visualizations and dashboards, and every step stays inspectable, editable and reproducible.

Lumen is built on Panel and the wider HoloViz stack. Its declarative data model means anything the language model produces can be serialized to YAML, reopened in a notebook, or composed into a dashboard.

Install with `pip install 'lumen[ai-openai]'` and start with `lumen-ai serve data.csv`.

Is this necessary for the LLM to know? And is it named lumen-llms.txt by you, or should it be named llms.txt?

These markdown files should help the LLM develop (think of it like a CLAUDE.md file).
For ref: https://panel-material-ui.holoviz.org/llms.txt

@ahuang11

ahuang11 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Let's wait until holoviz-dev/nbsite#361 is merged

@ahuang11
ahuang11 marked this pull request as draft August 4, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants