feat(docs): 907 — host an llms.txt for coding agents installing jarl #107
+38
−0
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # JARL: Atomic Routing Library | ||
|
|
||
| > A controlled-component router for React built on jotai atoms: each route is its own atom, | ||
| > matching a URL segment and reversible back into a URL. Framework-agnostic core (`jarl-atoms`) | ||
| > with lightweight React bindings (`jarl-react`). | ||
|
|
||
| - 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 | ||
|
Owner
Author
There was a problem hiding this comment. "kept their pre-rename names" historical fluff, LLM doesn't need anything about the rename here |
||
| `@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 | ||
|
Owner
Author
There was a problem hiding this comment. Can you confirm that any such snippets can be found anywhere? This library was never in common use so it seems unlikely. |
||
| online do not apply. | ||
| - `jarl-react` does not re-export `jarl-atoms`. Import route atoms (`rootAtom`, `staticRouteAtom`, | ||
| `paramRouteAtom`, ...) from `jarl-atoms`, and components/hooks (`Route`, `Link`, `Switch`, | ||
| `useNavigate`, ...) from `jarl-react`. | ||
| - `jarl-react` also peer-depends on React `^18 || ^19`. | ||
|
|
||
| ## Guides | ||
|
|
||
| - [Getting started](https://jarl.randomdev.co.uk/docs/getting-started): route atoms, the jotai | ||
| `Provider`, `Route` and `Link`, a minimal working app | ||
| - [Path variables](https://jarl.randomdev.co.uk/docs/path-variables): dynamic segments, nested | ||
| routes, query params | ||
| - [Data loading](https://jarl.randomdev.co.uk/docs/data-loading): `resolvedAtom` and | ||
| `asyncRouteAtom`, Suspense-based loading | ||
|
|
||
| ## API reference | ||
|
|
||
| - [jarl-atoms](https://jarl.randomdev.co.uk/api/jarl-atoms): route atom constructors, redirects, | ||
| query atoms | ||
| - [jarl-react](https://jarl.randomdev.co.uk/api/jarl-react): `Route`, `Link`, `Switch`, hooks | ||
|
|
||
| ## Optional | ||
|
|
||
| - [Changelog](https://jarl.randomdev.co.uk/changelog): version-by-version release notes | ||
| - [v1 history](https://jarl.randomdev.co.uk/history): why v1 was replaced — background only, not | ||
| current API | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"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:"