Documentation entry

Find the shortest path from evaluation to implementation.

This page is the entry point for the current `humming` docs set. The detailed guides still live in Markdown so they stay close to the codebase and version history.

Pick the path that matches the job in front of you.

evaluate

Assess fit first

Start with positioning and boundaries before reading implementation details.

overview README plugin-system

start

Launch a new app

Use the CLI, inspect examples, then move into production guidance once the shape is clear.

cli examples production

extend

Build plugins and hooks

Understand the plugin model first, then drop to the authoring guide and forward hooks.

plugin-system plugin-guide transport

operate

Prepare for rollout

Focus on transport policy, production guidance, local benchmarks, and the current roadmap.

transport benchmark roadmap

Core guides

Read the architecture and runtime boundaries first.

Overview

Positioning, architecture, core boundaries, and when `humming` is the right fit.

Plugin system

Extension model, governance direction, execution order, and growth strategy.

Transport

Forward transport strategies, keepalive, retry policy, and custom transport hooks.

Production

Runtime setup, operational concerns, and how to keep the service predictable.

Tooling guides

Use the CLI and benchmark docs when you want to move quickly.

CLI

Scaffold apps from templates and standardize local project bootstrapping.

Benchmark

Measure the forward baseline and compare direct upstream calls with proxied traffic.

Plugin guide

Code-level authoring details, examples, and patterns for building custom plugins.

Repository README

Main project landing page with quick start, official plugins, and examples.

Examples

Map the docs to runnable templates.

The examples folder is the fastest way to move from concepts to a running app. Use the matching example after each guide instead of trying to absorb everything at once.

basic with-plugins with-forward with-async-plugin

Operational depth

When the question is operational, follow the transport-to-rollout path.

`humming` is small, but the forward path, startup summaries, plugin lifecycle, and production boundaries still deserve deliberate reading. This set is the shortest way to get there.