Documentation Map
Use this page when you know what you are trying to accomplish but not the Minco term or page name. The current manual is organized by user intent rather than by crate layout.
Historical manuals remain available from the version selector, but current search intentionally prioritizes the latest stable manual and
Nextso old terminology does not crowd out current answers.
Start and learn
| Need | Page | What you will get |
|---|---|---|
| Install the toolchain and CLI | Installation | exact Rust/Minco versions and install commands |
| Build one application | Build your first application | SQLite-first working loop with production-shaped boundaries |
| Understand the development loop | Framework tour | contract-to-cloud sequence and project graph |
| Understand the filesystem | Project structure | domain/application/adapter/API/service ownership |
| Understand why Minco is structured this way | Architecture | planes, dependency direction, runtimes, plans, evidence |
Build application behavior
| Need | Page | Search terms |
|---|---|---|
| CRUD/resource conventions | Build a resource API | create, list, cursor, ETag, If-Match, Problem Details |
| Browser and native clients | Browser and native clients | mobile API, PKCE, OAuth, CORS, retry, offline, deprecation, app integrity |
| Exact HTTP resource shapes | Resource API reference | envelope, pagination, filter, sort, precondition |
| Configuration and secrets | Configuration | precedence, environment, secret reference, redaction |
| PostgreSQL/SQLite lifecycle | Migrations and seeders | SQLx, migration, seed, plan, verify |
| Identity and sessions | Identity and sessions | login, sign in, claims, principal, permission, session, revocation |
| Files and frontend assets | Files and static sites | upload, direct upload, object storage, S3, signed access, CloudFront, SPA |
| Events, rich mail, and delivery intent | Events and notifications | outbox, email, SES, Mailpit, webhook, notification |
| Durable action history | Durable action auditing | audit, action log, actor, changes, journal, relay, archive, retention |
| Background execution | Queues and workers | SQS, worker, partial batch, FIFO, DLQ |
| Realtime refresh signals | Realtime subscriptions | AppSync, subscription, invalidation, resync |
| Client/developer review loop | Client feedback loop | feedback, attachment, transcription, AI context |
| Waffo hosted checkout and webhooks | Waffo hosted payments | payment, checkout, GraphQL, webhook, signature, idempotency |
Local development and AI-native inspection
| Need | Page | Search terms |
|---|---|---|
| Run local dependencies and processes | Local development | dev profile, supervisor, readiness, Rustack |
| Inspect the application graph | ProjectView, MCP, and workbench | project view, graph, MCP, workbench, evidence lane |
| Develop with coding agents | Codex and Claude Code | agent plan, sync, doctor, context, eval |
| Diagnose a failure | Troubleshooting | doctor, drift, readiness, stale ETag, packaging, AWS plan |
Plugins and extension points
| Need | Page | Search terms |
|---|---|---|
| See official components | Built-in plugins and adapters | health, observability, storage, feedback, runtime, database |
| Add a component to an application | Install and compose plugins | Cargo feature, typed constructor, composition |
| Test plugin distribution and behavior | Plugin conformance guide | metadata, archive, offline conformance |
| Look up exact conformance rules | Plugin conformance reference | report, fixture, capability, evidence |
AWS, cost, and operation
| Need | Page | Search terms |
|---|---|---|
| Review and apply AWS topology | Plan an AWS deployment | Plan IR, SAM, CloudFormation, IAM, change set, promote, rollback |
| Use the Orders DynamoDB access model | DynamoDB adapter | conditional write, index, consistency, no scan |
| Understand the idle-cost promise | Zero idle, precisely | provisioned compute, wake source, residual cost |
| See one production decision end to end | Production blueprint | burst traffic, Lambda, PostgreSQL, DynamoDB, SQS, recovery |
Recipes and exercised examples
| Need | Page | What it demonstrates |
|---|---|---|
| Choose a practical composition | Practical recipes | CRUD, auth, uploads, notifications, review environments, frontend/API |
| Trace the reference API completely | Orders API end to end | contract, CRUD, adapters, HTTP behavior, planning |
| See what the repository actually exercises | Exercised examples | reference applications and evidence boundaries |
| Browse everything Minco claims today | Feature catalog | contract, data, services, workers, AWS, evidence, non-features |
Exact reference
Use reference when you need facts rather than a walkthrough:
For Rust type and function signatures, use the version-matched docs.rs API reference linked from the site navigation. Repository-generated package, plugin, schema, diagnostic, and release reference remains under docs/reference/generated/ in the source repository.
Common search vocabulary
Minco deliberately uses precise terms. These aliases can help when searching:
| If you are thinking… | Search for… |
|---|---|
| controller / route handler | handler, operationId, resource API |
| service layer | application use case, application port |
| repository / DAO | adapter, port, SQLx, DynamoDB |
| activity log / table history | durable action auditing, audit ledger, semantic action |
| login / sign in | identity, verified claims, sessions, revocation |
| mobile backend / native API | browser and native clients, PKCE, retry, compatibility |
| cron / scheduled job | schedule, wake source, worker |
| background job | SQS, worker, partial batch, DLQ |
| optimistic locking | ETag, If-Match, 412, revision |
| retry-safe POST | idempotency, Idempotency-Key, replay |
| deploy preview | Plan IR, change set, deploy plan |
| zero server cost | zero idle, residual cost, wake source |
| AI project context | ProjectView, MCP, agent context |
Version and freshness rules
The stable manual describes the published release. Next describes source on main that has not yet been released. A pull request, prototype, enum variant, or provider seam is not documented as shipped product behavior until it is part of the corresponding source/release boundary.
This matters when multiple framework changes are being developed in parallel: unmerged work can inform future documentation, but it must not silently rewrite the meaning of a frozen stable manual.
If you still cannot find the right page, start with Troubleshooting for failures or the Feature catalog for capability discovery.