Using devlanes? Please consider donating to support my open source work ❤️
Help devlanes grow! Star and share this amazing repository with your friends and co-workers!
The source of devlanes.run.
This repository builds devlanes.run: the landing page, the feature pages, the docs and the examples index. It is an Astro site with Starlight for the docs, deployed to Cloudflare.
The docs are not written here. Each build takes them from the latest release of devlanes, so to change a docs page, edit it in that repository's docs/ folder.
pnpm sync runs before every build and brings in what this repository does not hold. Nothing it writes is committed.
| Source | Taken from | Becomes |
|---|---|---|
| devlanes-run/devlanes | The latest stable release tag | docs/ at /docs/, the config reference generated from the two JSON Schemas, the schemas at /v1/, /install.sh and /install.ps1, and the TUI built for the browser |
| devlanes-run/examples | The main branch |
catalog.json and each example's README at /examples/ |
| This repository | The landing page, /lanes/, /remote/, /agents/, the layout, the styles and the Markdown plugins the docs render with |
A docs change reaches the site with the next devlanes release, and an example with the next push to the examples' main. Both repositories send this one a source-release dispatch, which rebuilds and deploys.
You need Node 24.16 or later and pnpm 12.
pnpm install
pnpm devpnpm dev syncs the content, then serves the site at http://localhost:4321. The sync reads GitHub, so it needs a network connection; set GH_TOKEN when the anonymous rate limit gets in the way.
To build with content that is not released yet, point the sync somewhere else:
| Variable | Use |
|---|---|
DEVLANES_REF |
A branch or tag of devlanes to build instead of the latest release |
DEVLANES_DIR |
A local checkout of devlanes |
DEVLANES_TUI_DIR |
A local build of the browser TUI, the output of packaging/scripts/tui-web.sh in devlanes |
EXAMPLES_DIR |
A local checkout of the examples |
DEVLANES_DIR=../devlanes pnpm devpnpm lint
pnpm test-types
pnpm build
pnpm testpnpm test runs the unit tests of the sync and the Markdown plugins, then the Playwright tests against the built site, so build first. Playwright needs its browser once: pnpm exec playwright install chromium. pnpm lint-fix and pnpm format fix what the linters report.
A docs page fails the build when a yaml devlanes block uses a key the schema does not have, when a Mermaid diagram does not render or has no accTitle, or when docs/nav.yaml names a page that does not exist.
CI runs the checks on every pull request and comments a preview URL on pull requests from this repository. A push to main builds the site and deploys it to Cloudflare with Wrangler.
| Path | Holds |
|---|---|
src/pages/ |
The landing page, the feature pages, llms.txt and the Markdown twin of every page |
src/components/, src/layouts/, src/styles/ |
The parts the pages and the docs share |
src/scripts/ |
Code that runs in the browser: the road scene, the live TUI, synced tabs, the install control |
integrations/ |
The Markdown plugins of the docs: directives, config blocks with hovers, the config reference, Mermaid and terminal blocks |
scripts/ |
The sync of the docs and the examples |
test/ |
Playwright tests |
design.md |
The copy rules, colours, layout and how each part of the site works |
Read design.md before changing copy or layout: it has the wording, the colours and the reason behind each part. For a docs page, open the pull request in devlanes instead.
Licensed under the MIT License. See LICENSE for more information.