This repo contains the source code to documentation website (https://www.arroyo.dev/docs) for Arroyo. Docs are developed as mdx (Markdown with embedded components).
We welcome contributions and fixes! Just open a PR.
We use Nimbus, an Astro-based docs framework, for our docs. The live website is automatically rebuilt on every merge to this repo.
Pages live in src/content/docs/; the sidebar is configured in astro.config.ts.
Shared snippets live in src/content/partials/ and are included with
<Render file="..." />. Components like <Aside>, <Tabs> and <TabItem> are
available in every page without an import (see src/components.ts).
The site is served under /docs on www.arroyo.dev. Write links between pages
without that prefix ([Kafka](/connectors/kafka/)); Nimbus adds it. Images in
public/ are the exception and need it: .
pnpm run lint:docs catches an image without it.
The REST API reference at /docs/api is generated from src/api/openapi.json,
Arroyo's OpenAPI spec. To update it, build Arroyo and copy its spec in unchanged:
$ cp ../arroyo/target/api-spec.json src/api/openapi.jsonDocs require Node 22.23.4 or later (nvm use picks up .nvmrc), and can be developed locally:
$ pnpm install
$ pnpm run dev # http://localhost:4321/docs/or built statically and previewed with
$ pnpm run build
$ pnpm run previewpnpm run preview:cf serves the build with Wrangler, as production does, including
the redirects in public/_redirects.
Check for broken links and other authoring mistakes with
$ pnpm run lint:docs