Prego Docs

User-facing documentation for the Prego platform, built with Astro and Starlight. Styled like docs.kinde.com.

Prerequisites

• Node.js 20 or newer (Astro 4 runs on current LTS). GitHub Actions and .nvmrc pin 24 for reproducible builds; use nvm use (or similar) if you want the same version locally.
• pnpm (recommended) or npm

Setup

cd prego_docs
pnpm install

Commands

Command	Action
pnpm dev	Start dev server (e.g. http://localhost:4321)
pnpm build	Build static site to dist/
pnpm preview	Preview production build locally

For a short post-change checklist (header, layout, Mermaid), see VERIFICATION.md.

Project structure

prego_docs/
├── src/
│   ├── content/
│   │   ├── config.ts    # Docs collection schema
│   │   └── docs/        # Markdown/MDX pages (published site)
│   ├── components/      # Header, PageFrame, sidebars, etc.
│   └── styles/          # Custom CSS
├── docs/                # Internal planning notes (not part of the build)
├── public/              # Static assets (favicon, `robots.txt`, `_redirects`, etc.)
├── astro.config.mjs     # Starlight config, sidebar, theme
├── .nvmrc               # Node version for CI (GitHub Actions)
├── package.json
└── README.md

Internal / engineering docs (Prego monorepo)

Multi-repo refactoring plans, Zuplo–Worker trust boundaries (X-Internal-Sig), and fork checklists are maintained in the Prego application monorepo (Starlight under Prego/docs), not in this user-facing site:

• Fork-ready platform hub
• Tenant trust boundaries — includes optional onboarding correlation (x-trace-id, trace_* shape) for support and integrations copy
• prego-zuplo gateway runbook index — operator entry point (not the Prego monorepo infra docs/runbook/)
• prego-zuplo runbook — allowed origins / CORS / x-trace-id — operator notes when browser preflight fails (ALLOWED_ORIGINS, custom CORS policies)
• With a local multi-repo checkout: ../Prego/docs/src/content/docs/platform/

Cursor: .cursor/rules/prego-platform-docs-pointer.mdc loads the same links when this repo is opened without the monorepo. Root AGENTS.md summarizes scope (user docs vs engineering).

Operator-focused control-plane notes (internal HTML tools, billing-test vs JSON, smoke script) live with the rest of engineering runbooks in the monorepo, for example tenant onboarding flow and prego-control-plane dashboard; see also onboarding / logpath / admin console plan.

Content (Kinde-style IA)

• Get started — Overview, quick start.
• Guides — Overview hub, authentication, Autopilot, users & access, billing, tenant onboarding, finance/HR/sales/operations, integrations, data & privacy.
• API — API overview and My AI reference.
• SDK — Integration overview for apps and backends.
• MCP — MCP Hub (user-oriented connection guide).
• Resources — Overview, glossary, FAQ, community.
• System — Status and communication expectations.

Deployment

• GitHub Pages: Build with pnpm build, deploy the dist/ directory. Note: GitHub Pages does not read public/_redirects. If you need /deploy/overview → /mcp/overview/, add a redirect in front of Pages (for example Cloudflare or Fastly) or replace old links at the source.
• Vercel / Netlify: Connect the repo, build command pnpm build, output dist. Confirm whether your plan applies _redirects from dist (Netlify does; Vercel uses vercel.json unless you rely on a compatible adapter).
• Cloudflare Pages: public/_redirects is copied into dist/ and honored for legacy /deploy/overview and /deploy/overview/ → /mcp/overview/ (301) for old bookmarks.
• Set site in astro.config.mjs to your production URL (e.g. https://docs.pregoi.com).
• robots.txt: Production public/robots.txt allows crawling and points to sitemap-index.xml on docs.pregoi.com. For preview or staging hosts, ship a stricter file (for example User-agent: * plus Disallow: /) or omit the Sitemap line so search engines do not index non-production URLs.

License

Same as the Prego project.