Documentation map
| Section | Contents | When to use it |
|---|---|---|
| Getting started | Concepts, your first app, Studio collaboration, learning path | Your first encounter with NocoBase 3 |
| Core manual | Application development, using and developing plugins, framework, deployment, reference | Look up the feature you are developing or maintaining |
| Studio manual | Installation, member access, tasks, projects, Agents, quality, releases, administration, reference | Look up operations for your role |
| Project tutorials | Environment and Agent selection, Core application development, Studio collaboration, best practices, appendices | Follow a project through successive stages |
| FAQ | NocoBase 2 and 3 differences, feature mapping, migration | Understand the relationship between versions |
Complete your first walkthrough
Read What is NocoBase 3 to understand the application foundation, development governance, and business apps.
- Creating an app yourself: follow Develop your first app to create, start, and develop customer management, then check role permissions before refining it.
- Joining a Studio team: go directly to Collaborate with Studio. If the team environment is not ready, an administrator starts with Installation and configuration.
Each walkthrough lists its own prerequisites. You do not need to read every manual first.
Develop and extend applications
Once the app runs, use the Application development overview to understand the parts of a feature, and Project structure to locate files. The development manual covers pages and interactions, services and APIs, data and permissions, background work, CLI commands, and testing.
For common capabilities such as authentication, files, and notifications, consult Using plugins. To maintain functionality independently or reuse it across applications, see Developing plugins. Consult the Framework when you need runtime, container, HTTP, or database internals.
Use and manage Studio
- Members: start with Raising requests and Sessions, then consult Progress, Answering questions, and Acceptance.
- Project owners: use Settings, Knowledge base, Project memory, and Progress, followed by Checks and review and Releases.
- Administrators: complete Installation, then manage Agents, Runtimes, Skills, Usage, Members and roles, and Upgrades and backups.
Studio's reference section contains statuses, permissions, Agent execution rules, commands, and configuration.
Follow a complete project
Build reliable business systems follows an asset-management application through environment setup, design, device management, requests and approvals, roles, acceptance, and deployment. It then introduces Studio collaboration, shared knowledge, and releases.
Use this route for sustained practice across a whole project. If you have completed the quickstart, continue from the stage that matches your experience and consult the manuals for specific mechanisms.
Deploy, maintain, and look up details
Before sharing an application with users, read Choose a deployment method, then Publish application releases. For databases, consult Compatibility and Database configuration.
Look up Core CLI commands and Configuration, or Studio CLI commands, Runner commands, and Configuration when needed.