flowmetrics

flowmetrics documentation

Organised by Diátaxis: four kinds of doc for four different needs. Pick the entry point that matches what you’re trying to do.

If you want to…	Read	Type
Learn the tool end-to-end	Tutorial	Tutorial
Solve one specific task	How-to guides	How-to
Look up a flag, file, or schema	Reference	Reference
Understand why it’s built this way	Explanation	Explanation

Tutorial — learn

• Tutorial — your first dashboard in 5 minutes — install, configure a workflow, materialize, browse. One linear path; copy-pasteable.

How-to guides — solve a problem

Task-specific recipes. Each page is self-contained — read just the one you need.

• Install on macOS, Linux, Windows
• Add a workflow in the browser
• Write a workflow YAML by hand
• Fetch data once
• Schedule data fetches
• Run the dashboard locally
• Run as a persistent web server
• Back up and restore
• Deploy with Docker
• Extract metrics for agents
• Upgrade
• Develop against a source checkout
• Troubleshooting

Full how-to index →

Reference — canonical facts

Dense, fact-oriented, no opinions.

• CLI, YAML, file layout, output envelopes — every command, every flag, every file the warehouse touches, every JSON envelope schema.
• Glossary — terms; the terms we deliberately avoid (Scrum-contaminated “backlog” and “velocity”).

Explanation — understand the design

Discussion of trade-offs and the math behind the numbers.

• Monte Carlo forecasting — flow forecast date and flow forecast throughput, with worked examples.
• Architectural decisions and known constraints — GitHub API caps, cache strategy, WIP-tracking source scope.
• GitHub label-driven CFD and Aging — design rationale + signal-quality contract.
• Screenshots — what the dashboard looks like against two real data sources.

Full explanation index →