feat(docs): 907 — host an llms.txt for coding agents installing jarl - #107
Open
randomdevpete wants to merge 1 commit into
Open
feat(docs): 907 — host an llms.txt for coding agents installing jarl#107randomdevpete wants to merge 1 commit into
randomdevpete wants to merge 1 commit into
Conversation
Serves the current adopted convention for hosted, agent-facing library instructions: a spec-compliant llms.txt at the docs site root, indexing the existing guides and API reference and calling out what an agent gets wrong without it — the jarl-atoms/jarl-react package names, that v1 was removed, and that jarl-react does not re-export jarl-atoms. Placed in packages/docs/public/ so Vite's static-asset copy ships it verbatim to dist/llms.txt, which the existing S3 sync deploys to https://jarl.randomdev.co.uk/llms.txt with no separate build step. Ticket: 907
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
Add
packages/docs/public/llms.txt, hosted athttps://jarl.randomdev.co.uk/llms.txt, to guide coding agents through installing and using the library.Convention Research
The producer verified the file format and availability by:
llms.txtis now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).##section headings with[Name](url): descriptionlinks to existing documentation sections — not a full-text dump.AGENTS.mdas the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers viaCLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.llms-full.txt: it would require a build-time markdown concatenation step, materially beyond the scope of "write and host some static instructions". Possible as a follow-up if agents prove they need it.The
llms.txtformat is deterministic and content-driven: a single static file served verbatim at a standard path, requiring no build step and no API layer, making it visible to any tool that can fetch a URL.Verification
fooAtom/fooRouteAtomnaming) are absent.See ticket 907 for the done-when criteria.