condensate This website is built from curated guides, visual explainers, and package manifests. Readers get rendered pages with search, navigation, code copying, and source links. Markdown is an authoring format; browsing repository files is no longer the documentation interface.
Build and preview
From the Condensate repository root:
bun run docs:build
bun run docs:dev
The preview is http://127.0.0.1:5192. DOCS_PORT can choose another port. The generated static site is apps/docs/dist and can be served by a static host with directory-index support. No model credentials or live runtime are required.
Edit a guide
Curated pages live in apps/docs/content; navigation, summaries, and implementation references live in apps/docs/src/catalog.ts. Package reference pages read current manifests during each build. The build rejects missing sources and broken internal page links.
Keep claims tied to the implementation. Distinguish an engine from a provider transport, a durable thread from a live session, and an implemented runner from a configured deployment. A proposed design belongs in an explicitly labelled historical or design record.
Validate changes
bun run --cwd apps/docs typecheck
bun run --cwd apps/docs test
bun run docs:build
bun run typecheck
bun run test
bun run lint:slop:ratchet
Check search, direct page URLs, mobile navigation, keyboard access, and a page with a long code example. Do not mark repository gates green when unrelated failures remain.
The Documentation website workflow builds and validates affected pull requests and uploads the product site and documentation together as a seven-day artifact. Use bun run site:build to produce this combined output in apps/site/dist, or bun run site:dev to preview it on port 5193. The site build mounts these docs at /docs/.
Keep repositories connected
Repository and workspace READMEs remain short entrypoints with setup context and links to the website. Historical audits and design discussions stay available in source; they are not silently promoted to current instructions.
Public guides cover implementations verified against the repository. Keep unpublished designs, local deployment notes, and historical audits out of the site catalog.