Skip to content

Commit a05c825

Browse files
committed
docs(readme): absolute GitHub URLs for unshipped-path links in the shipped package README [skip ci]
The package ships README.md (plus src/dist/skills) but not docs/ or e2e/, so relative links to those targets break for npm consumers reading the README from node_modules. Converted the seven such links (why-rango, matching-and-lazy-discovery, docs index, execution model, the three example apps) to canonical GitHub blob/tree URLs. Skill links stay relative — skills ship, so they resolve in both contexts. Repo-level docs keep repo-relative references by convention.
1 parent f380b3a commit a05c825

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎packages/rangojs-router/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ everything past the core is opt-in.
1010
This page is a tour: it builds one small shop and meets the entire core API
1111
along the way — about six primitives. Everything else is opt-in and linked at
1212
the end. For the design rationale behind these APIs, read
13-
[Why Rango](./docs/why-rango.md); this page shows how it feels, that page
13+
[Why Rango](https://github.com/ivogt/vite-rsc/blob/main/packages/rangojs-router/docs/why-rango.md); this page shows how it feels, that page
1414
argues why it's right.
1515

1616
## Install
@@ -132,7 +132,7 @@ per group — while matching stays an `O(path length)` prefix trie, identical
132132
in dev and production. None of this is assumed: the trie is benchmarked
133133
in-repo against multi-thousand-route manifests, and the lazy guarantees are
134134
pinned by run-count tests (see
135-
[matching & lazy discovery](./docs/internal/matching-and-lazy-discovery.md)).
135+
[matching & lazy discovery](https://github.com/ivogt/vite-rsc/blob/main/packages/rangojs-router/docs/internal/matching-and-lazy-discovery.md)).
136136
Grow the tree without watching the boot time.
137137

138138
That's a working site. Everything below adds to this app.
@@ -420,15 +420,15 @@ npx rango generate src/ # recursive scan
420420

421421
### Examples
422422

423-
- [`e2e/mini`](./e2e/mini) — single-file demo app
424-
- [`cloudflare-basic`](../../tests/cloudflare-basic) — Cloudflare Workers with caching, loaders, theme, and pre-rendering
425-
- [`cloudflare-multi-router`](../../examples/cloudflare-multi-router) — multi-app host routing
423+
- [`e2e/mini`](https://github.com/ivogt/vite-rsc/tree/main/packages/rangojs-router/e2e/mini) — single-file demo app
424+
- [`cloudflare-basic`](https://github.com/ivogt/vite-rsc/tree/main/tests/cloudflare-basic) — Cloudflare Workers with caching, loaders, theme, and pre-rendering
425+
- [`cloudflare-multi-router`](https://github.com/ivogt/vite-rsc/tree/main/examples/cloudflare-multi-router) — multi-app host routing
426426

427427
### Going deeper
428428

429-
- [Why Rango](./docs/why-rango.md) — the design rationale, claim by claim
430-
- [Docs index](./docs/README.md) — architecture, caching, prerender, testing
431-
- [Execution model](./docs/internal/execution-model.md) — the runtime contract
429+
- [Why Rango](https://github.com/ivogt/vite-rsc/blob/main/packages/rangojs-router/docs/why-rango.md) — the design rationale, claim by claim
430+
- [Docs index](https://github.com/ivogt/vite-rsc/blob/main/packages/rangojs-router/docs/README.md) — architecture, caching, prerender, testing
431+
- [Execution model](https://github.com/ivogt/vite-rsc/blob/main/packages/rangojs-router/docs/internal/execution-model.md) — the runtime contract
432432

433433
## License
434434

0 commit comments

Comments
 (0)