feat(docs): 907 — host an llms.txt for coding agents installing jarl by randomdevpete · Pull Request #107 · randomdevpete/jarl

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete · 2026-08-21T23:41:27Z

Summary

Add packages/docs/public/llms.txt, hosted at https://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:

Researching the current convention for hosted, consumer-facing agent instructions: llms.txt is now the standard format, adopted by OpenAI, Stripe, Cloudflare, Vercel, and the most comparable open-source libraries (TanStack and Zod).
Fetching live examples from those projects to confirm the format: H1 heading with library name, blockquote summary, then ## section headings with [Name](url): description links to existing documentation sections — not a full-text dump.
Examining and rejecting AGENTS.md as the vehicle: that convention is for agents working inside a repo as contributors (which this repo covers via CLAUDE.md), not for downstream consumers reading from their own codebase with no jarl source.
Examining and rejecting an MCP server: disproportionate scope for a routing library that already has a docs site. The routing behaviour is documented by code and examples, not through a separate tool interface.
Noting but deferring 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.txt format 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

All documentation links in the file have been verified against the docs site's actual route table.
Every factual claim about package names, versions, exports, and peer dependencies has been verified against the current source.
No unlanded tickets (675, 778, 789) are documented — their proposed API changes (async-data coalescing, navigation blocking, fooAtom/fooRouteAtom naming) are absent.
CODING-STYLE.md compliance: no ticket/epic/PR references, no padding, no marketing fluff.

See ticket 907 for the done-when criteria.

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

randomdevpete · 2026-08-25T05:59:16Z

@@ -0,0 +1,38 @@
+# JARL: Atomic Routing Library
+
+> A controlled-component router for React built on jotai atoms: each route is its own atom,


"controlled-component" inaccurate and contradictory here, also "for React" also not exclusively true as atoms can be used independently. Instead: "A router for React and vanilla JS projects, build on Jotai atoms:"

randomdevpete · 2026-08-25T06:00:22Z

+
+- Install both packages plus their `jotai` peer dependency: `npm install jarl-atoms jarl-react jotai`.
+ The npm package names are `jarl-atoms` and `jarl-react` — the GitHub repository is
+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or


"kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here

randomdevpete · 2026-08-25T06:01:02Z

+ `randomdevpete/jarl`, but the packages kept their pre-rename names; do not guess `jarl` or
+ `@jarl/*`.
+- The current major is v2, built entirely on jotai atoms. The v1 implementation (`RoutingProvider`,
+ `RouteMap`, React legacy context) was removed from the codebase; v1-era snippets found elsewhere


Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely.

randomdevpete commented Aug 25, 2026
View reviewed changes

		@@ -0,0 +1,38 @@
		# JARL: Atomic Routing Library

		> A controlled-component router for React built on jotai atoms: each route is its own atom,

Conversation

randomdevpete commented Aug 21, 2026

Summary

Convention Research

Verification

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

randomdevpete commented Aug 21, 2026

Summary

Convention Research

Verification

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

randomdevpete commented Aug 21, 2026

Summary

Convention Research

Verification

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

randomdevpete commented Aug 21, 2026

Summary

Convention Research

Verification

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant