Skip to content

Add build script for llms.txt and markdown docs#1732

Open
Azaya89 wants to merge 5 commits into
mainfrom
llm-txt
Open

Add build script for llms.txt and markdown docs#1732
Azaya89 wants to merge 5 commits into
mainfrom
llm-txt

Conversation

@Azaya89

@Azaya89 Azaya89 commented Jun 19, 2026

Copy link
Copy Markdown
Member

Fixes #1730

Description

This PR adds a build script for generating llms.txt and the relevant markdown docs.

Unrelated

  • Removed Streaming from doc/user_guide/index.md to clear the doc build warnings.

AI Disclosure

Tool & Model: GPT-5.3 Codex
Usage:

  • I have tested all AI-generated content in my PR.
  • I take responsibility for all AI-generated content in my PR.

Screenshot of generated llm.txt page

image

@maximlt

maximlt commented Jun 19, 2026

Copy link
Copy Markdown
Member

How long does the _docs-markdown step take? Are we going to have to add this script to every repo or are we planning to upstream that to nbsite or some other place?

@Azaya89

Azaya89 commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

How long does the _docs-markdown step take?

It's actually surprisingly fast. Didn't extend the build time significantly in any noticeable way.

Are we going to have to add this script to every repo or are we planning to upstream that to nbsite or some other place?

We may have to add it to every repo because each repo will have different sets of docs it needs to convert to markdown.

@ahuang11

Copy link
Copy Markdown
Collaborator

One thing to keep in mind is token efficiency, i.e. try to cull useless info. For example, hvplot.hvPlot.area is a bit excess in my opinion, and can be simplified to area under API Manual. Also each section ideally would have a caption, like in https://panel-material-ui.holoviz.org/llms.txt:

## Component Reference

Detailed reference documentation for every Panel Material UI component, organized by category.```

@Azaya89

Azaya89 commented Jun 23, 2026

Copy link
Copy Markdown
Member Author

I've updated the script.

@Azaya89 Azaya89 requested review from ahuang11 and maximlt June 23, 2026 14:49
@ahuang11

Copy link
Copy Markdown
Collaborator

Can you show the new output for some?

@Azaya89

Azaya89 commented Jun 23, 2026

Copy link
Copy Markdown
Member Author

Can you show the new output for some?

/markdown/ref/api/manual/hvplot.hvPlot.area.md

image

Parts of /markdown/ref/plotting_options/legend.md

image

@Azaya89 Azaya89 self-assigned this Jul 2, 2026
@Azaya89

Azaya89 commented Jul 2, 2026

Copy link
Copy Markdown
Member Author

I've updated the script to convert all the docs (except the user guide section). PR description also updated.

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.

Implement llms.txt standard

3 participants