Grid Docs

Canonical documentation for Grid Platform — install, operate, and extend the infrastructure orchestration stack.

Source of truth

All human-facing guides live in this repository under docs/. The same tree feeds the future Docusaurus site (docs.gridplatform.org).

docs/
  intro.md                 # Landing
  install/
    overview.md            # Choose VM vs Compose vs source
    vm.md                  # Command list for a fresh VM
    docker-compose.md      # Compose-based install
    configuration.md       # Env vars & secrets
  concepts/
    overview.md
  admin/
    rbac.md                # Environments, groups, approvals
  cli/
    aws-gcp.md             # CLI generate → plan → apply

Install scripts / Compose files version with product code in grid-core (install/). This repo documents how to use them.

The org .github repo is for profile/branding only — not product docs.

Local preview

git clone https://github.com/gridplatform/grid-docs.git
cd grid-docs
npm install
npm start

Open the URL printed by Docusaurus (usually http://localhost:3000).

npm run build    # production build → build/
npm run serve    # serve the build

Contributing

Fork → branch → pull request against main. See CONTRIBUTING.md.

---

Built with ❤️ by the Grid Platform team