Appearance
Documentation Map
This page is the complete navigation hub for the NGB Platform documentation site.
Verified: published page inventorySuggested reading routes
How to use this page. Use this page when you know the kind of question you have but do not remember which section contains the best answer. It mirrors the published sidebar structure so every page in the docs set is reachable from here.
Fast routing
| Need | Best page |
|---|---|
| I am new to NGB and need the shortest onboarding path | Reading Path |
| I need local startup instructions | Run Locally |
| I need to create or upgrade an independent application | External Applications and Upgrades |
| I need to add application definitions, runtime behavior or PostgreSQL storage | Extend an External Application |
| I need a short architecture entry point | NGB Platform Architecture Brief |
| I am evaluating NGB from an ERP/accounting ecosystem angle | NGB for ERP and Accounting Software Ecosystem Teams |
| I need the high-level architecture | Architecture Overview |
| I need module boundaries and dependency rules | Layering and Dependencies |
| I need to trace runtime orchestration | Runtime Source Map |
| I need to trace reporting execution | Reporting Execution Map |
| I need the curated deep-dive set | Topic Chapters Index |
| I need to implement Document Actions or Work Center | Document Actions and Work Center |
| I need to configure or extend deployment-wide feature flags | Feature Flags |
| I need to enable attachments and notes or configure their storage | Attachments & Notes |
| I am upgrading an existing 2.x solution to 3.0.0 | Migration 2.0.0 → 3.0.0 |
| I am upgrading an existing solution to 2.0.0 | Migration 1.3.1 → 2.0.0 |
| I need the Document Actions or Work Center HTTP contract | Document Actions and Work Center API |
| I need implementation guidance | Developer Workflows |
| I need configuration keys and environment variables | Configuration Reference |
| I need source-tracing pages and class-level maps | Source-Anchored Class Maps |
Site topology
Documentation Home
Use the home page for the fastest entry into the site when you want the core links without the full inventory.
Start Here
Use Start Here before deep-diving into individual modules.
Architecture
Core architecture
- NGB Platform Architecture Brief
- Architecture Overview
- External Applications and Upgrades
- Layering and Dependencies
- Definitions and Metadata
- Runtime Request Flow
- HTTP → Runtime → PostgreSQL Execution Map
- Host Composition and DI Map
Business model concepts
- Catalogs
- Documents
- Document Flow
- Document Actions
- Accounting Effects
- Reporting: Canonical and Composable
- Report Browsing and Direct Downloads
- Accounting and Posting
- Closing Period
- Operational Registers
- Reference Registers
- Derive
- Append-only and Storno
Cross-cutting capabilities
Use Architecture when the question is “how the platform works” rather than “where a file lives”.
Ecosystem
- NGB for ERP and Accounting Software Ecosystem Teams
- Integration and Extension Opportunities
- Evaluation Guide
Use Ecosystem when the question is how NGB should be evaluated by architects, ERP/accounting software teams, ISVs, consultants, or external reviewers.
Platform
Module pages
- Core and Tools
- Metadata
- Definitions
- Runtime
- API
- Persistence
- PostgreSQL
- Accounting and Registers
- Background Jobs
- Performance Testing
- Migrator
- Watchdog
- Security and SSO
- Security and Permissions
- Audit Log
Source maps
- Runtime Source Map
- Runtime Execution Map
- Reporting Execution Map
- PostgreSQL Source Map
- API Source Map
- Metadata Source Map
- Definitions Source Map
- Accounting Source Map
- Operational Registers Source Map
- Reference Registers Source Map
- Ops Hosts and Bootstraps Source Map
- Source-Anchored Class Maps
Deep dives
- Topic Chapters Index
- Accounting and Posting Deep Dive
- Operational Registers Deep Dive
- Reference Registers Deep Dive
- Documents, Flow, Effects, Derive
- Closing Period Deep Dive
- Audit Log Deep Dive
- Background Jobs Deep Dive
- Migrator Deep Dive
- Watchdog Deep Dive
Dense chapters
- Runtime Execution Core Dense Source Map
- Document Subsystem Dense Source Map
- Reporting Subsystem Dense Source Map
- Ops and Tooling Subsystem Dense Source Map
- Definitions and Metadata Boundary Dense Source Map
- Document + Definitions Integration Dense Source Map
- Reporting + Definitions Integration Dense Source Map
- Document + Reporting Cross-Cutting Integration
Collaborator maps
- Runtime Execution Core Collaborators Map
- Document Subsystem Collaborators Map
- Reporting Class Collaborators Map
- Ops and Tooling Class Collaborators Map
- Definitions and Metadata Collaborators Map
- Document + Definitions Integration Collaborators Map
- Reporting + Definitions Integration Collaborators Map
- Document + Reporting Cross-Cutting Collaborators
Supporting models
Use Platform when you need responsibility boundaries, verified anchors, execution paths, or deep subsystem context.
Guides
Core workflows
- Developer Workflows
- Extend an External Application
- Platform Extension Points
- Add a Document with Accounting and Registers
- Add a Canonical Report
- Add a Composable Report
- Document Actions and Work Center
- Migration 2.0.0 → 3.0.0
- Migration 1.3.1 → 2.0.0
Scenario guides
- Guide: Business Partners Catalog
- Guide: Sales Invoice
- Guide: Item Price Update
- Guide: Inventory and Receivables Operational Registers
- Guide: Item Pricing Reference Register
- Guide: Canonical and Composable Reports
Use Guides when you are changing code, extending a vertical, or using the docs as an implementation checklist.
Reference
Site guide
Operational reference
- Platform Projects
- Configuration Reference
- Background Job Catalog
- Migrator CLI
- Platform API Surface
- Document Actions and Work Center API
- Layering Rules
- Database Naming Quick Reference
- Database Naming and DDL Patterns
Verified anchor sets
- Definitions/Metadata Boundary Verified Anchors
- Document Subsystem Verified Anchors
- Reporting Subsystem Verified Anchors
- Runtime Execution Core Verified Anchors
- Ops and Tooling Verified Anchors
- Document + Definitions Integration Verified Anchors
- Reporting + Definitions Integration Verified Anchors
- Document + Reporting Cross-Cutting Verified Anchors
Use Reference when you need site guidance, operational lookup pages, or narrow source indexes.
Trust model for this documentation set
This site intentionally separates:
- source-tracing pages;
- architecture synthesis;
- template guidance for extending the platform.
That separation keeps the site readable for day-to-day engineering work without collapsing overview pages, implementation maps, and extension guides into one layer.