Skip to content
github-actions[bot] edited this page Sep 12, 2026 · 5 revisions

This wiki is generated from the Minnow repository. Use the in-app ? button for help that matches your installed version.

Minnow documentation

Everything written down about Minnow — the free and open source, full agentic development workspace — in one index.

Using Minnow

In-app help: menubar ?#/wiki ( documentation/manual/ plus roadmap). GitHub Wiki: full tree including contributor/, context.md, and maintainer runbooks.

Doc What's in it
Minnow manual Install, Code, chat, shortcuts, data, troubleshooting (canonical for users, describes what ships today).
Roadmap Active direction and what is still being built (also in-app).
Guides index Redirect stubs for stable GitHub links → manual or contributor.

Building & contributing

Doc What's in it
Contributor index Setup from source, commands, architecture, board testing, a11y, LAN.
Setup from source Clone, install, providers, npm start, dev variants.
Commands Every npm script, headless CLI, test suites, environment variables.
Architecture The three processes, SPA, tool server, agent layer.
context.md Complete technical reference: every subsystem, API, and store.
Tool authoring Local tool plugins for ~/.minnow/tools/.
Agent packs Bundle prompts and agents for sharing.
Design system --mn-* tokens, primitives, themes.
DESIGN.md Palette, typography, elevation, component rules.
PRODUCT.md Who it's for, design principles.
AGENTS.md Orientation for AI coding agents in this repo.

Maintaining Minnow

Doc What's in it
Maintainer index Release, signing, wiki publishing, settings inventory.
Releasing Versioning, packaging, auto-update feed.
Release notes Per-version notes for GitHub (v0.0.1.md, v0.0.2.md, …).
macOS signing Notarization and entitlements.
Wiki publishing GitHub Wiki staging from documentation/.
Settings reference Exhaustive settings and env inventory.
Prompt ownership matrix Who owns which prompts.

Working folders

Inputs to tools and agents — not primary reading:

  • plans/ — feature plans (Plan mode writes under documentation/plans/ in your workspace too).
  • schemas/, templates/, specs/ — JSON schemas and scaffolding.
  • memory/, MEMORY.md — curated notes for agents on Minnow itself.
  • archive/ — migration snapshots and shipped one-off plans.
  • images/ — README screenshots.

Clone this wiki locally