docs: serve llms.txt and per-page markdown for LLM consumers#188
Draft
Lutherwaves wants to merge 1 commit into
Draft
docs: serve llms.txt and per-page markdown for LLM consumers#188Lutherwaves wants to merge 1 commit into
Lutherwaves wants to merge 1 commit into
Conversation
Adds the mkdocs-llmstxt plugin and Material's content.action.view feature so the site exposes three LLM-friendly entry points: - /llms.txt — curated index per llmstxt.org - /llms-full.txt — entire site concatenated as plain markdown - "View source" button per page → raw .md on GitHub Lets agents and crawlers consume the docs as text rather than scraping rendered HTML.
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
3 tasks
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
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.
Summary
Makes the docs site consumable by LLMs and agents as text, not rendered HTML — addresses the pushback on shipping more HTML chrome before improving how the existing markdown is served.
Three entry points after this PR:
/llms.txt— short, curated index per the llmstxt.org spec. Lists each guide with its URL pointing at the raw.md./llms-full.txt— entire site concatenated as plain markdown (~2.4k lines today). Single-file ingest for embedding pipelines / RAG..mdon GitHub for one-off agent access.Changes
requirements-docs.txt— addmkdocs-llmstxt==0.5.0(pure Python, no new native deps; Cairo etc. are not required for this plugin)mkdocs.ymlcontent.action.viewMaterial featureplugins:block withsearch(re-declared because adding the section disables the default) andllmstxtconfigured with curated sections matching the existing navVerification
site/llms.txt:Test plan
Docsworkflow builds without errorshttps://tink3rlabs.github.io/magic/latest/llms.txtresolveshttps://tink3rlabs.github.io/magic/latest/llms-full.txtresolvesOut of scope (future)
llms.txtoverride (the auto-generated one is good enough for now)🤖 Generated with Claude Code