Skip to content

Documentation

Plumego is a stdlib-first Go web toolkit for explicit HTTP services. The recommended way to approach the repository is to start with the canonical reference path, then move outward into module boundaries and extension families.

step 1

Start with Getting Started

Confirm the smallest reference path works before moving deeper into boundaries and extension families.

Open getting started

step 2

Follow the Reference App

Read the canonical application path from bootstrap to app wiring to route registration.

Open reference app

step 3

Then classify modules and boundaries

Move to stable roots and x/* families when you need to decide where a change belongs.

Open modules overview

step 4

Finish with release posture

Check release posture and roadmap summary before assuming a package is already stable.

Open release posture

module facts

Modules and boundaries

The default learning path starts with stable roots. Capability work starts from the primary extension families.

Stable roots

9

Primary extension families

11

Open modules overview

release facts

Release posture

Read the support matrix synced from README before assuming long-term compatibility.

Current version

v1.0.0-rc.1

Support groups

5

Open release posture

roadmap facts

Current direction

The roadmap summary is synced from docs/ROADMAP.md before each build.

In progress

3

Planned

4

Open roadmap

These summaries all come from prebuild-synced repository facts instead of a website-only copy.

canonical path

Getting Started

Run the smallest reference path first and confirm the default Plumego entry flow.

Open getting started

reference

Reference App

Read the canonical app layout from bootstrap to wiring to route registration.

Open reference app

boundaries

Modules Overview

See the stable-root versus extension split before deciding where work belongs.

Open modules overview

stable surface

Stable Roots

Understand which packages define the default learning path and what should stay out of them.

Open stable roots

extensions

x/* Family

Start capability work from the primary extension families instead of pushing it into stable roots.

Open x/* family

compatibility

Release Posture

Read the support matrix before assuming a package already carries long-term compatibility.

Open release posture

direction

Roadmap

Check what the repository is hardening now, what comes next, and what stays out of scope.

Open roadmap

releases

Releases

Inspect the current version, support groups, and README-synced release matrix.

Open releases
  • the canonical application path
  • module boundaries and repository shape
  • release posture and current compatibility expectations