@falai/agent documentation site

The docs and code examples for @falai/agent. Built with React, TypeScript and Vite.

Run locally

Install Bun, then install the dependencies:

bun install

Start the site:

bun run dev

Open http://localhost:5173. The command reads the docs and examples from the installed @falai/agent package and generates src/content-metadata.json for the routes and sidebar.

Update the content

Docs live in the agent package, not this repo. After a new package version is published, update it and regenerate the metadata:

bun run sync

To regenerate metadata without updating the package, run bun run metadata.

Check your changes

bun run lint
bun run typecheck

Build

bun run build

The dist folder contains the rendered HTML for each page, the browser assets, the docs and examples under /content, a sitemap, robots.txt and a 404 page. dist-ssr is the server-rendering bundle used by the build; it is not the site to upload.

Preview the built site with bun run preview. Deploy dist to a static host such as Cloudflare Pages, Netlify or Vercel.

Edit the site

• src/pages: landing page, docs and examples pages.
• src/components: navigation, Markdown and code viewers.
• src/config/publicPages.ts: page titles and descriptions.
• src/App.css and src/index.css: styles.
• scripts/metadata.ts: content routes and sidebar data.
• scripts/prerender.ts: rendered pages and search metadata.
• vite.config.ts: copies the package content into the build.

MIT © 2025