Skip to content

Repository files navigation

fastagent.sh

The public website, rendered documentation, and blog for FastAgent.

Development

Clone with the documentation source:

git clone --recurse-submodules https://github.com/fastagent-sh/website.git
cd website
npm install
npm run dev

Node 22.18 or newer — the build scripts import TypeScript directly.

Before opening a pull request:

npm run check
npm run build

Stack

Astro, static output, deployed to Cloudflare Workers Static Assets.

  • /docs/* runs on Nimbus, Cloudflare's Astro documentation framework. Its starter files live in this repo and are edited here; nimbus.json tracks what came from the registry, and npx nimbus-docs outdated reports what upstream has moved on.
  • The landing page and the blog use a hand-written shell (src/layouts/Site.astro); the 404 runs on the docs shell, so a missed URL still lands somewhere with search and navigation.
  • Both read one palette (src/theme.ts) and one mode switch, so crossing between them keeps the reader's theme.

Every docs page also ships a Markdown twin at /docs/<slug>/index.md, indexed by /llms.txt and /llms-full.txt, with /start.md as the guided path for a coding agent.

Content ownership

  • Landing pages, blog posts, and brand assets are authored here.
  • Framework documentation is authored in fastagent-sh/fastagent.
  • npm run sync:docs renders the pinned vendor/fastagent revision. Generated documentation is not committed.

Deployment

The static Astro build in dist/ deploys through Cloudflare Workers Static Assets. Production is https://fastagent.sh.

CI deploys automatically on every push to main (the deploy job in .github/workflows/ci.yml, authenticated by the CLOUDFLARE_API_TOKEN repo secret). npm run deploy remains as the manual break-glass path.

About

The FastAgent website, documentation, and blog.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages