docs: point the Legion API link at the new docs mount - #7
Conversation
The Legion API reference moved from the ReadMe site to docs.picogrid.com/legion, built from the legion-docs repo. The guide header's Legion API link still resolved to /reference/start, and the resolver's root allowlist had no `legion` entry, so it also refused a LEGION_DOCS_URL override pointing at the new mount. The link fails closed either way. - defaultPath becomes /legion/ - documentationRoots gains `legion` `reference` is retained: the ReadMe site it names is still served on this host, so a build can still be pointed back at it while that remains true. Test fixtures follow the new default. Both affected suites pass: docs:legion:test 18/18, docs:check:deploy:test 46/46.
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Included review availability: 8 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour. 📝 WalkthroughWalkthroughThe Legion documentation target changed from ChangesLegion documentation URL
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to The PR updates the Legion API documentation link and allows the new Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
`Exact release artifact` is a required check and it runs `npm audit --audit-level=high`, which now fails on a high-severity nanoid advisory: custom generators can loop indefinitely when size is zero, affecting < 3.3.18. nanoid is transitive here, astro -> vite -> postcss -> nanoid, so the lockfile is the only place to pin it. Fails on untouched main too, so this is not fallout from the docs change in this branch; it is bundled because the gate blocks the merge either way. npm update nanoid --package-lock-only. Six lines. After it, npm audit --audit-level=high reports zero vulnerabilities at any severity, and both docs suites still pass: docs:legion:test 18/18, docs:check:deploy:test 46/46.
|
Added a second commit to clear the failing required check.
After the bump: Happy to split this into its own PR if you would rather keep the docs change isolated. It is bundled only because the gate is required and blocks the merge either way. |
The Legion API reference moved from the ReadMe site to
docs.picogrid.com/legion, built from thelegion-docsrepo. The guide header's Legion API link still resolved to/reference/start, and the resolver's root allowlist had nolegionentry, so it also refused aLEGION_DOCS_URLoverride pointing at the new mount. The link fails closed either way.Change
docs/site/legion-documentation.mjsreferenceis retained deliberately: the ReadMe site it names is still served on this host, so a build can still be pointed back at it while that remains true. It can come out once ReadMe is switched off.Which target
I used
/legion/, the mount root. Two alternatives if you would rather:/legion/reference/— the API reference section specifically, which matches the link's label most literally/legion/getting-started/start/— the exact mapped equivalent of the old/reference/startper the redirect table inlegion-docsAll three return 200 today. Happy to switch to whichever you prefer.
Tests
Fixtures in
legion-documentation.test.mjsandcheck-deploy-contract.test.mjsfollow the new default, including the roots loop and the two error-message assertions that list the allowlist. Run locally:Not in scope
readme-overcapture-probe.mjsstill probes the host root and expects it not to be the ECN Worker. That stays correct: it compares against the ECN Worker's own CSP, so a different origin serving the root does not trip it. Worth re-checking when the root is actually cut over.Reviewer note
CODEOWNERSmaps/docs/to@picogrid/edge, so this requests that team. One approval needed.Summary by CodeRabbit
/legion/path by default.legiondocumentation root is now recognized alongside existing documentation paths.