-
-
Notifications
You must be signed in to change notification settings - Fork 5
Contributor
github-actions[bot] edited this page Sep 4, 2026
·
2 revisions
Documentation for cloning the repo, running from source, testing, and understanding the architecture. End-user help lives in ../manual/ (in-app ? wiki).
| Doc | What it covers |
|---|---|
| setup-from-source.md | Clone, npm install, providers, npm start, dev variants, health checks |
| commands.md | npm scripts, headless CLI, test suites, environment variables |
| architecture.md | SPA, tool server, Electron shell, agent layer — orientation before context.md
|
| apps-and-routes.md | App registry, hash routes, release gate, per-app internals |
| Doc | What it covers |
|---|---|
| orchestrate-board-testing.md |
test:orchestrator, fake model, scenario contract, journal suite |
| accessibility-audit.md | Keyboard-first checklist, focus, screen readers, contrast regression |
| lan-companion.md | LAN pairing, security boundary, companion layout (MIN-393) |
| Resource | Role |
|---|---|
../context.md |
Authoritative technical reference — APIs, stores, every subsystem |
../maintainer/ |
Releases, signing, settings inventory, wiki publishing |
../design-system/ |
--mn-* tokens, primitives, themes |
../plugins/tool-authoring.md |
Local tool plugins in ~/.minnow/tools/
|
../agent-packs/README.md |
Portable prompt/agent bundles |
../../AGENTS.md |
Orientation for AI coding agents |
../../DESIGN.md |
Visual design rules |
../../PRODUCT.md |
Product principles |
Full documentation index: ../README.md.
Generated from documentation/. Do not edit generated pages directly.
Extensions
Developer reference
Contributing
- Accessibility and keyboard-first audit
- Minnow apps
- Architecture overview
- Command reference
- LAN companion
- Orchestrator V2 board testing
- Contributing to Minnow
- Setup from source
Design system
- CSS file map
- Layout shell
- UI primitives
- Minnow design system (current state)
- Minnow Shell
- Themes
- Design tokens
Guides
- Accessibility and keyboard-first audit
- Minnow apps
- Architecture overview
- Command reference
- Configuration & storage
- Keyboard shortcuts
- LAN companion
- Model bench: Flip Match v1
- Orchestrate board testing
- Minnow guides
- Release E2E testing guide
- Setup guide
- Troubleshooting
- Minnow wiki
Maintainers
- macOS release signing & notarization
- Prompt ownership matrix (MIN-379)
- Releasing Minnow
- Settings reference
- GitHub Wiki publishing
Apps
Chat
Core concepts
Extend Minnow
Get started
Orchestrate
Overview
Reference