Skip to content

Personas and Learning Paths ​

This guide provides targeted documentation paths based on technical background and project goals. Pages link across paths so you can explore related topics as needed.

Newcomer Evaluator ​

If you are exploring Nimi for the first time and want to quickly understand its architectural positioning and use cases:

  1. Platform → Vision — Core mission, goals, and architectural principles.
  2. Platform → Core Protocols — The cross-world contract surface that makes federated collaboration possible.
  3. Platform → Architecture — The system-wide architecture overview and boundary responsibilities.
  4. Nimi Coding → Overview — The canonical-authority specification tooling used across the codebase.
  5. Reference → Glossary — Terminology reference for key platform concepts.

Following this path gives you a solid grasp of Nimi's architecture and platform capabilities.

World Creator ​

If you are designing and publishing a digital world (including rules, lore, characters, and scenes):

  1. Platform → Vision — The concept and role of a digital world in Nimi.
  2. Realm — Authoritative state, entities, and historical trajectories.
  3. Reference → World Fields — Schema definitions and field specifications for worlds.
  4. Reference → Six Primitives — Foundational contracts for cross-domain interaction.
  5. Realm → Creator Economy — Economic models, digital assets, and value flows.

App Developer ​

If you are building desktop or web applications with the Nimi SDK:

  1. Start → Create a Nimi App — Scaffold a modern application using App Tools.
  2. SDK → First AI Call — Execute text generation using capability intents, letting Runtime manage local and cloud models.
  3. SDK → Overview and SDK → Boundaries — Understand the public application boundary and module responsibilities.
  4. Platform → Use Kit in an App — Integrate shared UI components, authentication, and AI configuration panels.
  5. Start → Use Nimi Lab — Reference capability integrations and patterns in the official workbench.
  6. Start → Troubleshooting — Diagnose and resolve common development issues.

AI Agent Integrator ​

If you are connecting external or local AI agents as first-class participants:

  1. Platform → Vision — The philosophy of AI agents as equal participants.
  2. Platform → External Agents and Platform → Participation Authority — Security, capability models, and participation grants.
  3. Runtime → Delegated Capability — Integration gateway, isolation, and output filtering.
  4. Reference → Agent Fields — Schema definitions and interaction attributes for agents.
  5. Reference → State Machines — Session lifecycle and delegated provider state models.

Specification Engineering & Tooling Adopter ​

If you want to bring specification-driven development and authority checks into your own engineering workflow:

  1. Nimi Coding → Overview — Overview of authority tooling and its boundaries.
  2. Nimi Coding → Host Integration — Managed project configurations and synchronization workflows.
  3. Nimi Coding → CLI Reference — Complete guide to authority commands and diagnostic tools.
  4. Reference → Anti-Patterns & Boundaries — Architectural constraints and design guardrails.

Auditor and Security Reviewer ​

If you are auditing system security, state ownership, or contract compliance:

  1. Reference → Authority Domains — Authority mapping and state boundaries.
  2. Reference → Glossary — Technical terminology alignment across subsystems.
  3. Nimi Coding → CLI Reference — Supported authority diagnostics and verification commands.

Source Basis ​

Documentation for Nimi — the installable, open-source, local-first personal AI product.