feat: add llms.txt documentation index source - #1
Open
David Mireles (louzt) wants to merge 4 commits into
Open
Conversation
Add a dedicated llms-txt source type for documentation sites that publish an index at llms.txt, including relative Markdown link resolution, host/include/exclude filtering, and an end-to-end Iroh example.\n\nAlso exports the extraction helper for unit testing and adds a small node:test suite covering absolute URLs, relative links, and filtering behavior.
Add ready-made scraper configs for the stable Rust documentation surface and the docs.rs about/build pages, plus README notes so those presets are discoverable for future protocol/runtime research.
Add a ready-made Quinn docs snapshot preset and document it in the README so future SnapPipe/QUIC research can reproduce the local docs capture workflow.
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
1 participant
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
Adds a dedicated
llms-txtsource type so documentation sites that publish a machine-readable index atllms.txtcan be snapshotted without manually curating URL lists.What this changes
llms-txtas a first-class source typeexamples/iroh-llms.jsonconfig forhttps://docs.iroh.computer/llms.txtVerification
npm testnode src/cli.mjs run --config examples/iroh-llms.json54pages discovered in the current run)