Personas
Reading paths for the most common readers of the Nimi public docs. Each persona has a primary route through the documentation; pages also link laterally so readers can cross between paths.
Newcomer Evaluator
You heard about Nimi and want to decide in 30 minutes whether this project matters to you.
- Platform → Vision — what this project is for.
- Platform → Six Primitives — the cross-world contract surface that makes the platform a platform.
- Platform → Architecture — the cross-layer map that says who owns what.
- Nimi Coding → Overview — the canonical-authority tooling used by this repository.
- Reference → Glossary — keep this open as you read.
After this path you can describe Nimi to someone else.
World Creator
You want to design a world — its rules, lore, Characters, scenes — and publish it.
- Platform → Vision — what a world is.
- Realm — semantic truth, world state, world history.
- Reference → World Fields — exactly what a world looks like at the field level.
- Reference → Six Primitives — the cross-world contracts your world participates in.
- Realm → Creator Economy — economic semantics for creators across worlds.
App Developer
You want to build an app on Nimi using the SDK.
- Start → Create A Nimi App — scaffold a developer app with app-tools, or map the same ownership rules onto an existing app.
- SDK → First AI Call — make a Runtime-backed text generation call with owner capability intent and Runtime-selected execution.
- SDK → Overview and SDK → Boundaries — learn the public app boundary before importing SDK modules.
- Platform → Use Kit In An App — reuse shared UI, shell, auth, telemetry, AIConfig composition, and feature surfaces.
- Start → Use Nimi Lab — study the capability integration App and the slices admitted by App Tools.
- Start → Troubleshooting — interpret Runtime, SDK, Nimi Lab, and scaffold failures.
AI Agent Integrator
You want to integrate an external AI host as a participant.
- Platform → Vision — agents as first-class participants.
- Platform → External Agents and Platform → Participation Authority — the security and participation model for external agents.
- Runtime → Delegated Capability — the gateway and output firewall.
- Reference → Agent Fields — what an agent looks like, including external agent fields.
- Reference → State Machines — delegated provider and delegated session state machines.
Nimi Coding Adopter
You want to adopt Nimi Coding as canonical-authority tooling in a project of your own.
- Nimi Coding → Overview — the authority tooling and its repository boundaries.
- Nimi Coding → Host Integration — the managed host files and synchronization flow.
- Nimi Coding → CLI Reference — the supported authority commands.
- Reference → Forbidden Claims — the evidence-gated public-claim policy applied to docs.
Auditor / Reviewer
You are reviewing Nimi against admitted authority. You need to trace public claims back to source.
- Reference → Authority Domains — who owns what.
- Reference → Glossary — vocabulary alignment.
- Nimi Coding → CLI Reference — the supported authority diagnostics and validation commands.