🔍⌘K

Start typing to search docs.

Docs Contribution Guide

1.0.0

How to update docs content, lint changes, and import legacy markdown.

Update flow

  1. Edit markdown/MDX under apps/landing/src/content/docs or legacy markdown in docs/.

  2. Run the docs linter:

    pnpm docs:lint
    
  3. Preview locally with pnpm --filter @app-factory/landing dev and browse to /docs.

  4. Commit changes alongside relevant code updates so docs stay synchronized with behavior.

Info

The docs site imports legacy markdown directly (e.g., docs/ARCHITECTURE.md). Update those files in place; the docs hub will render them automatically.

Adding new pages

  • Register the page in apps/landing/src/lib/docs/manifest.ts with slug, title, description, and source.
  • Use the reusable MDX components (<Callout />, <Tabs />, <CliSnippet />, <DocLink />) for consistent styling and navigation.
  • If a page is enterprise-only, set enterpriseOnly: true in the manifest so gating and analytics behave correctly.

Legacy content

  • Pages flagged with legacy: true show a banner automatically. Use this for pre-Supabase workflows that should not influence new work.
  • Keep legacy docs up to date enough to provide context, but add explicit migration steps when behavior diverges.

Testing

  • Docs pages rely on filesystem reads; run pnpm lint and pnpm test:smoke to ensure Next.js builds and smoke tests continue to pass.
  • For API/CLI auto-generation, rerun the docs after modifying ops/forge-api/openapi.yaml or CLI metadata. The docs will parse the latest definitions at request time.