Golain documentation

End-user documentation for the Golain IoT platform, built with Mintlify.

Repository: golain-io/docs

Scope

Tab	Covers
Platform	Getting started, web console (pw)
Tools	platform-tui CLI/TUI, golain-cli
Edge	Omega runtime, JITR, deployment, SQLite sync
Self-hosted	vm-edge operator stack, local dev

Product repositories:

• ilyama — API, workers, MQTT broker
• pw — web console
• omega — edge client

Local preview

npm i -g mint
mint dev

Open http://localhost:3000.

mint broken-links

Publishing

Connect the Mintlify GitHub app in the dashboard to deploy on push to main.

Sync OpenAPI from ilyama

cd ../ilyama/services/apis
go run ./openapi/cmd/sync
cp openapi/ilyama.v1.json ../../docs/api-reference/ilyama.v1.json

Brand assets

Logos and favicon live under logo/ and favicon.svg. Source: golain-web brand SVGs. Update manually when marketing refreshes assets.

Starter kit pages are disabled via .mintignore — see _starter-disabled/README.md.

AI-assisted editing

npx skills add https://mintlify.com/docs

For agent instructions see AGENTS.md.

Mintlify admin MCP (write access) is configured in Cursor via mintlify-admin in ~/.cursor/mcp.json. Credentials are stored locally in ~/secured/mintlify-mcp.env — not in this repo.

Contributing

1. Branch from main
2. Edit MDX under the appropriate section
3. Update docs.json when adding or renaming pages
4. Run mint broken-links before opening a PR

See CONTRIBUTING.md for Mintlify starter-kit conventions.