Home of the docs.shorebird.dev site.
The /roadmap page fetches live data from Linear at build time. To see real
data locally, export your Linear API key before running the dev server:
export LINEAR_API_KEY=your_key_here
npm run devYou can create a personal API key at Linear → Settings → API → Personal API Keys. Without the key the page renders a fallback message instead of crashing.
In CI the key is read from the LINEAR_API_KEY repository secret.
The table on
Flutter Versions
is generated from Flutter's public release feeds into
src/data/flutter-releases.json. Regenerate it with:
npm run update-flutter-releasesThe flutter-releases workflow runs the same script daily and fails when the
committed file has fallen behind Flutter's stable channel, so a new release
shows up as a red build rather than a stale page.
The "Highlights" column is hand-written in src/data/release-highlights.ts,
summarized from Flutter's release announcements. A new release line needs an
entry there; without one the table falls back to a plain release-notes link.
Both are separate from src/consts.ts, which tracks the Flutter version
Shorebird ships and is still bumped manually.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run update-flutter-releases |
Refresh src/data/flutter-releases.json |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.