Zgrid Developer Docs

Last reviewed: 2026-05-13
Maintained by: Engineering

This site is the internal documentation portal for the Zgrid monorepo. It is intended for developer onboarding, day-to-day implementation work, QA, and operational handoff.

Quick map

• Get Started: onboarding, local setup, and repo orientation
• Applications: what each app does, who uses it, how to run it, and feature status by surface
• Environments: local, staging, and production operating patterns
• Architecture: technical foundations such as database, email, storage, and monitoring
• Operations: deploy flow, hosting, migrations, and runbooks
• QA: validation strategy, smoke checks, and regression watch areas
• Product: workflow and access rules that engineering needs during implementation
• External Services: third-party platforms, dashboards, and internal placeholders
• Reference: stable contracts, conventions, and standards

Source of truth

• Markdown source lives in the repo-level docs/ folder.
• The Docusaurus site shell lives in apps/docs.
• When updating developer documentation, edit the markdown in docs/ so both Git-based review and the portal stay aligned.

Start here

1. Read Developer Index.
2. Follow Local Development.
3. Read Applications Overview to understand the app boundaries.
4. Check the Environment Contract before changing config.

Recommended next reads by task

• New engineer orientation: Developer Onboarding
• “What does each app do?”: Applications Overview
• “What features already exist?”: Features by Application
• “Which environment values matter?”: Environment Overview
• “Which external platforms are involved?”: External Services Overview
• “Where are the important dashboards and URLs?”: Useful Links

Running the docs portal locally

From the repo root:

corepack pnpm install
corepack pnpm run docs:dev

Build verification:

corepack pnpm run docs:build

Local docs URL:

• http://localhost:3004