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 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 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

• 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

• Platform Overview
• Reading Path
• Run Locally
• Manual Local Runbook
• Repository Structure
• Host Composition

Use Start Here before deep-diving into individual modules.

Architecture

Core architecture

• Architecture Overview
• 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
• Accounting Effects
• Reporting: Canonical and Composable
• Accounting and Posting
• Closing Period
• Operational Registers
• Reference Registers
• Derive
• Append-only and Storno
• Idempotency and Concurrency

Use Architecture when the question is “how the platform works” rather than “where a file lives”.

Platform

Module pages

• Core and Tools
• Metadata
• Definitions
• Runtime
• API
• Persistence
• PostgreSQL
• Accounting and Registers
• Background Jobs
• Migrator
• Watchdog
• Security and SSO
• 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

• API runtime PostgreSQL integration
• Platform document persistence model

Use Platform when you need responsibility boundaries, verified anchors, execution paths, or deep subsystem context.

Guides

Core workflows

• Developer Workflows
• Platform Extension Points
• Add a Document with Accounting and Registers
• Add a Canonical Report
• Add a Composable Report

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

• Documentation Map
• Documentation Consolidation Guide

Operational reference

• Platform Projects
• Configuration Reference
• Background Job Catalog
• Migrator CLI
• Platform API Surface
• 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.