Thank you for contributing documentation to Grid Platform.
- Fork gridplatform/grid-docs
- Create a branch:
git checkout -b docs/your-topic - Edit Markdown under
docs/ - Preview:
npm install && npm start - Open a pull request against
main
Do not push directly to main. Branch protection + review is the open-source path.
| Topic | Path |
|---|---|
| Install / VM / Compose | docs/install/ |
| Concepts | docs/concepts/ |
| Admin / RBAC / approvals | docs/admin/ |
| CLI guides | docs/cli/ |
Install scripts belong in grid-core/install — link to them from these docs; do not duplicate shell scripts here.
- Prefer short pages with tables and copy-pasteable commands
- Link to GitHub repos with absolute URLs
- Call out lab vs production clearly (passwords,
GRID_AUTO_APPROVE, public IPs) - Keep Docusaurus front matter (
title) accurate for the sidebar
Contributions are under the MIT License (see LICENSE).