Skip to content

Adoption Path

This page is the narrow adoption path for new Plumego users.

The first impression should be simple: standard-library HTTP compatibility, small stable kernel, explicit wiring, and machine-checkable agent workflow. Optional x/* packages are capability additions, not alternate bootstraps.

Read:

  1. Getting Started
  2. reference/standard-service/README.md

Use:

  • core.DefaultConfig
  • core.New
  • app.Use
  • app.Get
  • contract.WriteResponse
  • contract.WriteError

Avoid:

  • x/* packages
  • custom response envelopes
  • hidden route registration

Done when a local service responds from one explicit route using http.HandlerFunc.

Keep reference/standard-service as the app shape. Add one capability family:

NeedFirst read
CRUD / resource conventionsx/rest Primer
Tenant resolution and isolationx/tenant Primer
Edge proxy and rewritex/gateway Primer
WebSocket transportx/websocket Primer
Observability exportersx/observability Primer
AI provider / session / tool primitivesx/ai Primer

Done when the app still has explicit route wiring and only the selected capability family is added.

Read:

  1. AGENTS.md
  2. Canonical Style Guide
  3. Agent-First Workflow
  4. specs/repo.yaml
  5. specs/dependency-rules.yaml
  6. the target module’s module.yaml

Done when a developer or agent can answer:

  • which module owns the change
  • which paths are out of scope
  • whether stable public APIs are affected
  • which validation commands must pass

When updating README, website, or onboarding docs, present Plumego in this order:

  1. standard-library compatibility
  2. small stable kernel
  3. explicit reference application path
  4. machine-checkable agent workflow
  5. optional experimental capability catalog