Docs Introduction

Introduction

This section exists for one purpose:

To help you decide whether Plumego is worth your time.

Plumego is not designed to be universally appealing.
It is intentionally selective in what it optimizes for — and equally explicit about what it does not.

Before you read any tutorials, APIs, or examples,
you should understand the assumptions, values, and tradeoffs behind Plumego.


What This Section Covers

The documents in this section explain:

  • What Plumego is — and what it is not
  • Why Plumego was designed this way
  • What tradeoffs were consciously made
  • When Plumego should not be used
  • How Plumego fits into the broader Birdor engineering philosophy

There is intentionally very little code here.

This is not a tutorial section.
It is a decision-making section.


Who Should Read This First

You should start here if you are:

  • Evaluating Plumego as a framework choice
  • Responsible for long-term system maintenance
  • Making architectural decisions for a team
  • Considering replacing an existing framework
  • Unsure whether Plumego’s philosophy aligns with your project

If you are only looking for a quick way to spin up an API server,
this section may convince you to stop — and that is a valid outcome.


Reading Order

The recommended reading order is intentional:

  1. What is Plumego
    Understand the scope and intent of the framework.

  2. Design Philosophy
    The core principles that guide every design decision.

  3. Tradeoffs
    What Plumego gives up — explicitly and consciously.

  4. When Not to Use Plumego
    Clear boundaries and non-goals.

  5. Plumego and Birdor
    How Plumego fits into the broader engineering ecosystem.

Each document builds context for the next.


What You Will Not Find Here

To avoid confusion, it is important to state what this section does not include:

  • Step-by-step setup instructions
  • Code snippets for common tasks
  • API references
  • Performance benchmarks
  • Feature comparisons based on popularity

Those belong elsewhere.


A Note on Tone

Plumego documentation is written with the assumption that:

  • You are comfortable reading technical prose
  • You value clarity over persuasion
  • You prefer explicit reasoning over implicit convention

If this tone feels overly cautious or conservative,
Plumego may not be the right framework for your project.


Next

If you are ready to continue, start with:

→ What is Plumego

If you already suspect Plumego is not a good fit:

→ When Not to Use Plumego

Both are correct next steps.

In this section

  • What Is Plumego
    Plumego is a minimal, standard-library-first Go service framework designed to provide a stable engineering skeleton for long-term systems.
  • Design Philosophy
    The core design principles behind Plumego and the reasoning that guides every architectural decision.
  • Tradeoffs
    The explicit tradeoffs Plumego makes in exchange for long-term maintainability, predictability, and architectural clarity.
  • When Not to Use Plumego
    Clear guidance on scenarios where Plumego is not a good fit, based on project goals, team structure, and risk tolerance.
  • Plumego and Birdor
    How Plumego fits into the Birdor engineering ecosystem and why its design philosophy originates from long-term platform thinking.