Skip to content

docs: generate llms-full.txt for LLM accessibility#356

Open
Wenzel wants to merge 1 commit into
mainfrom
improve-llm-tsffs-docs
Open

docs: generate llms-full.txt for LLM accessibility#356
Wenzel wants to merge 1 commit into
mainfrom
improve-llm-tsffs-docs

Conversation

@Wenzel
Copy link
Copy Markdown
Contributor

@Wenzel Wenzel commented Jun 4, 2026

Fixes #355

Summary

  • Adds a single shell step in the docs CI pipeline that concatenates all documentation pages (in SUMMARY.md order) into a single llms-full.txt file
  • The file is served at https://intel.github.io/tsffs/llms-full.txt
  • Allows LLMs to ingest the full TSFFS documentation in a single request, without crawling ~77 individual HTML pages

Changes

Single addition to .github/workflows/docs.yml after mdbook build:

grep -oP '\([^)]+\.md\)' src/SUMMARY.md | tr -d '()' | while read -r f; do
  echo; cat "src/$f"
done > book/html/llms-full.txt

Why this approach

  • No new tools or dependencies — pure shell, runs in the existing CI environment
  • Zero ongoing maintenance — file regenerates automatically on every doc change
  • ~213 KB / ~6000 lines — fits in a single large LLM context window
  • Correct ordering — follows SUMMARY.md chapter order (intro → setup → config → harnessing → fuzzing → tutorials → developer)

Test plan

  • Tested generation locally — output verified to be well-formed and complete
  • CI passes (docs build + linkcheck)

🤖 Generated with Claude Code

Add a single shell step after `mdbook build` that concatenates all doc
pages in SUMMARY.md order into book/html/llms-full.txt. This file is
served at /llms-full.txt and allows LLMs to ingest the full TSFFS docs
in one request without crawling individual pages.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

Add llms-full.txt for LLM accessibility of documentation

1 participant