Skip to content

docs(build): developer guides for game servers, routing, and runtime capabilities#40

Open
hbrombeer wants to merge 1 commit into
mainfrom
docs/platform-architecture
Open

docs(build): developer guides for game servers, routing, and runtime capabilities#40
hbrombeer wants to merge 1 commit into
mainfrom
docs/platform-architecture

Conversation

@hbrombeer

@hbrombeer hbrombeer commented Jun 6, 2026

Copy link
Copy Markdown
Member

Folds the genuinely developer-useful platform concepts into the Build tab as helpful, honest developer docs — reframed as "what you do and get" rather than platform internals, and grounded in current capability maturity (verified against the code) instead of the roadmap.

New pages

Concepts

  • game-servers — what a gamemode push becomes under Agones (Fleet/GameServer, Ready/Allocated, replicas) without touching Kubernetes
  • connecting-players — how a player actually reaches your server (<mode>-<handle>.mc.grnds.io → edge → Velocity → your allocated server)

Runtime (new group — what your app gets at runtime)

  • environment-and-secrets — per-app env vars (shipped) + encrypted secrets (rolling out; writes 503 until the key is provisioned + the carrying release deploys)
  • databases — what survives a push; honest that there's no managed per-app database today (persist in an external DB via a secret; managed Postgres is roadmap)
  • messaging — declaring + publishing NATS events from your grounds.yaml; honest that reliable cross-app pub/sub is not yet proven
  • backend-services — the service type (push an HTTP service, get a URL) vs the in-progress first-class gRPC domain-service story

Cleanup

  • Corrects build/observability: grafana.platform.grnds.io is reachable but not project-isolated, so the supported per-developer surfaces (portal Logs tab, grounds logs, portal metrics) now lead; Grafana is framed as an operator/ad-hoc tool.
  • The earlier (overly internal) standalone Architecture tab from this branch was dropped in favor of this developer-focused integration.

How it was produced

Capability maturity was verified against the real code first (env vars, secrets, Postgres, NATS-from-app, services, Grafana access), then each page was written from that ground-truth and reviewed on two axes: developer usefulness and accuracy/honesty (no roadmap-as-shipped). Pages mark early/unavailable capabilities plainly.

Validation

All internal links resolve, frontmatter + MDX-safety checks pass, docs.json nav fully covers the new pages. Relying on the Mintlify preview build on this PR for the authoritative check.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Jun 6, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
grounds 🟢 Ready View Preview Jun 6, 2026, 6:05 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Fold the genuinely developer-useful platform concepts into the Build
tab, reframed as "what you do and get" (not platform internals) and
grounded in current capability maturity rather than the roadmap:

- concepts/game-servers — what a gamemode push becomes under Agones
- concepts/connecting-players — how a player reaches your server
- runtime/environment-and-secrets — per-app env vars + encrypted secrets
- runtime/databases — what persists across a push (honest: no managed DB)
- runtime/messaging — declaring + publishing NATS events (cross-app is roadmap)
- runtime/backend-services — the service type and its real current maturity

Adds a Runtime group and two Concepts pages to the Build nav. Also
corrects build/observability: Grafana is reachable but not project-
isolated, so the supported per-developer surfaces (portal Logs tab,
`grounds logs`, portal metrics) lead instead of Grafana.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@hbrombeer hbrombeer force-pushed the docs/platform-architecture branch from df95a24 to 384587b Compare June 6, 2026 18:29
@hbrombeer hbrombeer changed the title docs(architecture): add platform architecture section docs(build): developer guides for game servers, routing, and runtime capabilities Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant