docs: serve an llms.txt index of the documentation - #1939
Open
ghostiee-11 wants to merge 8 commits into
Open
ghostiee-11 wants to merge 8 commits into
ghostiee-11 wants to merge 8 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1939 +/- ##
==========================================
+ Coverage 75.27% 76.96% +1.68%
==========================================
Files 212 216 +4
Lines 39238 40674 +1436
==========================================
+ Hits 29538 31303 +1765
+ Misses 9700 9371 -329 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
|
Let's wait for https://github.com/holoviz/hvplot/pull/1732/changes to settle |
ahuang11
marked this pull request as draft
July 21, 2026 22:41
Collaborator
Author
|
Okay!! |
ghostiee-11
marked this pull request as ready for review
July 24, 2026 17:20
Contributor
|
Do you have an example artifact I can look at |
Collaborator
Author
Contributor
Is this necessary for the LLM to know? And is it named These markdown files should help the LLM develop (think of it like a CLAUDE.md file). |
Contributor
|
Let's wait until holoviz-dev/nbsite#361 is merged |
ahuang11
marked this pull request as draft
August 4, 2026 16:08
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.
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.
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
force-pushed
the
add/llms-txt
branch
from
August 24, 2026 17:21
2eafabc to
fbdd7a2
Compare
ghostiee-11
marked this pull request as ready for review
August 24, 2026 17:21
Contributor
|
Can you attach the latest llms.txt |
Collaborator
Author
|
Here's the current output: llms.txt |
Contributor
|
I think it seems too long and not too useful for developing Lumen (lots of the docs are user-facing). Can we figure a way to consolidate? |
Collaborator
Author
|
Updated output after consolidating the index around development and API documentation: llms.txt |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
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.