mirror of
https://github.com/anomalyco/opencode.git
synced 2026-08-04 14:59:49 +00:00
1.3 KiB
1.3 KiB
Website and documentation guide
Structure
- This package owns the
opencode.aiwebsite. - Add custom marketing routes as Astro files under
pages/. - The whole project is mounted at
/v2/bydeployment.base, and documentation lives undercontent/docs/at/v2/docsthroughbasePathinblume.config.ts. - Write documentation in MDX. Every page should have
titleanddescriptionfrontmatter. - Use parenthesized content folders for sidebar groups that must not add a URL segment. Keep ungrouped top-level pages directly under
content/docs/. - Put static files in
public/and reference them with root-relative paths. - The API reference is generated from
openapi.json; do not duplicate endpoint documentation as hand-written MDX. - Keep documentation aligned with the V2 packages. Do not use
packages/opencodeas the source of truth unless the task explicitly concerns V1.
Local development
- Run
bun devfrom this package and preview the site athttp://localhost:3000/v2/. - Verify both custom marketing routes and documentation routes after changing shared navigation or layout code.
Validation
- Run
bun typecheck,bun validate, andbun run buildfrom this package after documentation or configuration changes. - Treat validation and build errors as blockers.