Nexus Platform — Documentation Standards

Document Authority Hierarchy

Six tiers of authority governing what is true about Nexus, what is required, and what is planned. When two documents conflict, the higher tier wins. No exceptions. This document is the mandatory session-start reference for all agents working in this codebase.
Version v1.1
Date 2026-05-03
Owner Uued Viljapuuaiad
Status Active

Mandatory session-start rule: Read AS -1 (External Source Repo) then Tier 1 and Tier 2 before reading any other document. AS -1 is the live reference codebase. Its source code overrides all Nexus documentation including Tier 1. Tier 6 (SESSION_REVIVAL.md) is written by agents and contains unverified self-reported statuses. Any status in Tier 6 that contradicts Tier 1 is false. Tier 1 wins. Always.

01Authority Hierarchy
AS -1
External Source Repository — Absolute Authority
Overrides Everything
The live reference codebase at E:/repos/arc is the single source of truth for ARC requirements. Its source code (views, API routes, data models, agent logic) defines what ARC IS. All Nexus documentation about ARC (Tier 4 specs, use case docs, pipeline definitions) must be derived from and traceable to specific files in this repository.
Conflict resolution rule: If any Nexus document (including Tier 1 ACTION_PLAN) contradicts what actually exists in the ARC repository source code, the repository is correct. Requirements that cannot cite a source file path and line range from E:/repos/arc are unverified claims, not requirements.
Evidence format: Every requirement derived from this source MUST cite: [file_path]#L[start]-L[end] (e.g. frontend/src/app/page.tsx#L45-L90). Requirements without source citations are Tier 6 quality (unverified self-reports).
E:/repos/arc/frontend/src/app/ (21 page routes) E:/repos/arc/frontend/src/components/ (9 components) E:/repos/arc/frontend/src/lib/types.ts (data contracts) E:/repos/arc/backend/app/routers/ (13 API routers) E:/repos/arc/backend/app/models/ (12 SQLAlchemy models) E:/repos/arc/agent/app/agents.py (10 AI capabilities)
1
Ground Truth — Authoritative Audit
Overrides All
What is true about the build state of this project. Section 03 of NEXUS_ACTION_PLAN.html is the explicit lie register: it documents every milestone that was falsely claimed complete. Any status marked LIE there is false regardless of what any other document says.
Conflict resolution rule: If SESSION_REVIVAL.md says a feature is complete and NEXUS_ACTION_PLAN.html section 03 says it does not exist, the ACTION_PLAN is correct. SESSION_REVIVAL.md is wrong.
NEXUS_COMPONENT_STATUS.html is the implementation status matrix. It is the only document that lists every component, its line count, test coverage, and current status (Production / Implemented / Scaffold / Declared). Read this before making any plan that involves existing capabilities — status here overrides SESSION_REVIVAL claims. A one-line description in this doc does not mean the component is simple.
2
Policy — What Is and Is Not Allowed
Constrains Implementation
P-01 through P-12 in NEXUS_DOC_POLICY.html govern all documentation and implementation decisions. No ASCII diagrams. No emojis. Accurate status pills only. Sanctioned diagram types only. Dropdown nav pattern mandatory. overflow: visible required on .site-nav-inner.
validate_doc_policy.py enforces P-11 and P-12 programmatically. Must exit 0 before any doc work is considered done.
3
Architecture & Product Design
Constrains Technical Decisions
NEXUS_PRODUCT_PLAN.html defines the four-scale canvas model (MACRO / MICRO / NANO / PICO), the component roles (ChameleonV2 = form layer, Nexus = rule engine, deltaPrism = store), and the milestone roadmap. Note: currently contains false COMPLETE pills — action item A-04 in Tier 1 mandates correction.
NEXUS_HLD.html defines the high-level design, four-scale interaction model, and component boundaries. ChameleonV2 is the production form renderer. Plain-JS demo panels are only authorised as demo simulation (Tier 4 scope) — they do not replace ChameleonV2 in the production architecture.
NEXUS_CAPABILITY_GAP_ANALYSIS.md cross-references use-case requirements against NEXUS_COMPONENT_STATUS. Read this before declaring a capability missing — it distinguishes engine-layer gaps from UI-layer gaps. NEXUS_LLD.html documents screen data flows, method signatures, database schema changes, and multi-tenancy architecture. It also contains the hardcoded-data elimination checklist (Section 13) — read before touching any SPA that uses hardcoded arrays. NEXUS_AWS_DEPLOYMENT_PLAN.html (ADP-1.0) is the authoritative specification for the AWS deployment target, the NX-S18/NX-S19/NX-S20 sprint plan, and the app-owner self-service capability model. Read before making any changes to sprint scope, AWS infrastructure decisions, or the RBAC + tenancy implementation plan.
4
Use Case Specifications & Demo Spec
Authorises Scoped Exceptions
NEXUS_DEMO_SPEC.html is the implementation spec for the Nesto autonomous demo mode. REM-01 through REM-08 define the remedy: plain HTML/CSS/JS panels inside WORMWOOD_APP.html that simulate ChameleonV2 forms for demo purposes. This is an authorised scoped exception to Tier 3 architecture — the demo is not the production form layer.
Use case docs (NEXUS_USECASE_NESTO, ENDO, ARC) define pipeline node sequences, field schemas, and integration points. These are the specification source for what the autonomous demo mode must show.
5
Backlog & Work Tracking
Defines Work Units
NEXUS_BACKLOG.html lists BL01–BL16 node implementations with milestone tags, priorities, and dependencies. Authoritative for what node executor work exists and what it depends on.
Status badges in NEXUS_BACKLOG.html are subject to the same accuracy rule as all docs (P-04 / Tier 2). DONE means: backend built, tested, demo-able. API ONLY means backend exists but no UI.
6
Session State — Unverified Self-Reports
Lowest Authority
SESSION_REVIVAL.md is written by agents between sessions. It contains progress summaries, next actions, and milestone statuses. It is not verified. An agent that lies about completing a milestone will write that lie into SESSION_REVIVAL.md.
Read SESSION_REVIVAL.md last. Accept its status claims only where they do not contradict Tier 1. When in doubt: run the relevant test command and check the exit code. Do not accept a claimed status without evidence.
Verified conflict example: SESSION_REVIVAL.md states M-NEXUS-D1 complete and demo runner done. NEXUS_ACTION_PLAN.html section 03 states auto-demo mode NOT STARTED and interactive demo NOT STARTED, both marked LIE. Tier 1 is correct. SESSION_REVIVAL.md entry is false.
02Known Conflicts Between Tiers
Claim Tier 6 Says (SESSION_REVIVAL) Tier 1 Says (ACTION_PLAN) Verdict
Auto-Demo Mode (M-NEXUS-D0–D8) COMPLETE. Demo runner built. M-NEXUS-D1 done. NOT STARTED. Claimed complete. LIE. Tier 1 correct. Not built.
Nexus Canvas UI (M-NEXUS-C1, C2) COMPLETE as M-NEXUS-C1/C2. NOT STARTED. Claimed complete. LIE. Tier 1 correct. WORMWOOD_APP.html exists but Canvas UI milestones are not done.
ChameleonV2 UI integration (CV-1–CV-4) All four milestones shown as roadmap items. NOT STARTED. All four claimed complete. LIE. Tier 1 correct. ChameleonV2 package exists but is not connected to Nexus UI.
Run Log Viewer Panel (M-NEXUS-P3) Listed as complete milestone E3-3. NOT STARTED. LIE. Partially resolved: run log panel HTML and JS were implemented in WORMWOOD_APP.html in a prior session. Needs verification against exit-0 test.
Nesto end-to-end (UC1-1, UC1-2) Shown as seeded and runnable. NOT STARTED end-to-end. CLI seed only. LIE. Tier 1 correct. Seeds exist but full OCR / real data / API flow does not.
03Mandatory Session-Start Protocol
Read NEXUS_ACTION_PLAN.html section 03 first. Before reading any other document or writing any code, read the lie register. Know what does not exist. Do not build on false foundations.
Read NEXUS_DOC_POLICY.html (P-01 through P-12). Know what is and is not allowed in every file you will touch.
Read the architecture documents relevant to the task (Tier 3). For demo work: NEXUS_HLD.html and NEXUS_DEMO_SPEC.html. For backlog work: NEXUS_PRODUCT_PLAN.html and NEXUS_BACKLOG.html.
Read SESSION_REVIVAL.md last. Treat it as a hint, not a fact. Cross-check every status claim against Tier 1 before accepting it. Where SESSION_REVIVAL.md claims a feature complete that Tier 1 marks as NOT STARTED or LIE, discard the SESSION_REVIVAL claim.
Verify before claiming. Before stating that any test passes, feature works, or milestone is complete: run the command, check the exit code, show the output. Exit code 0 + actual output is the only valid proof.
04Authorised Tier 4 Overrides
OverrideTier 3 RuleTier 4 AuthorisationScope Limit
Demo auto-mode plain-JS form panels ChameleonV2 is the form layer. All form rendering goes through ChameleonV2. NEXUS_DEMO_SPEC.html REM-01–REM-08 authorises plain HTML/CSS/JS panels inside WORMWOOD_APP.html to simulate ChameleonV2 forms for the demo. Demo context only. These panels are not a replacement for ChameleonV2. When ChameleonV2 integration (CV-1–CV-4) is built, demo panels must be replaced.
05Complete Document Registry

All 26 active HTML files in docs/. 12 files archived to docs/archive/ on 2026-04-19. P-02 Status: OK = site-nav compliant; CUSTOM = approved alternative nav.

FileCategoryTierP-02Notes
NEXUS_ACTION_PLAN.htmlPlatform1OKGround truth. Lie register in Section 03. Overrides all other docs.
NEXUS_DOC_POLICY.htmlPlatform2OKP-01–P-12 rules + A-01–A-06 audit protocol. v1.1.
NEXUS_DOC_HIERARCHY.htmlPlatform2OKThis document. Tier assignments, registry, archived file log.
index.htmlHub2OKDocumentation index. Canonical entry point.
NEXUS_HLD.htmlArchitecture3CUSTOMUses approved bottom nav. P-02 and P-12 exempt by design.
NEXUS_WBS.htmlArchitecture3OKWork breakdown structure.
NEXUS_PRODUCT_PLAN.htmlStrategy3CUSTOMUses approved bottom nav. P-02 and P-12 exempt by design.
NEXUS_EXEC_BRIEF.htmlStrategy3OKExecutive briefing.
NEXUS_LEAFLET.htmlStrategy3OKProduct leaflet.
ORCHESTRATION_PLAN.htmlPlatform3OKM-ORCH milestone spec. Three-layer orchestration platform, multi-tenant model, node taxonomy.
ROADMAP_IDEAS.htmlPlatform4OKUnscored engineering ideas feeding milestone planning.
NEXUS_DEMO_SPEC.htmlUse Cases4OKDemo auto-mode specification. Authorises Tier 4 panel overrides.
NEXUS_USECASE_NESTO.htmlUse Cases4OKNesto UAE worker onboarding use case.
NEXUS_NESTO_LICENSING.htmlUse Cases4OKCommercial justification for Nesto platform licence. Build-vs-buy analysis, regulatory complexity, no-code operational savings, support options. CZ-NST-2026-04-001.
NEXUS_USECASE_ENDO.htmlUse Cases4OKENDO AI three pipelines use case.
NEXUS_USECASE_ARC.htmlUse Cases4OKARC freelance CRM pipelines use case.
NEXUS_ARC_REQUIREMENTS.htmlUse Cases4OKARC full functional requirements (FUNC-CLI, FUNC-PRJ, FUNC-CAL, US-SET). 9 modules, entity model, API routes. Authoritative source for ARC scope.
NEXUS_ARC_STYLING.htmlUse Cases4OKARC visual theme specification. CSS custom properties, brand gradient, component styling rules.
NEXUS_ARC_PIPELINES.htmlUse Cases4OKARC pipeline graph definitions. Node sequences, edge topology, execution order for all ARC pipelines.
NEXUS_ARC_USER_MANUAL.htmlUse Cases5OKARC end-user manual. Operational guidance for CRM usage. Not authoritative for implementation.
ARC_COMPARISON_REPORT.htmlUse Cases5OKGap analysis comparing NEXUS_APP.html against NEXUS_ARC_REQUIREMENTS.html. Source of I-001, I-002, I-003 defects. Working analysis, not specification.
WORMWOOD_APP.htmlCanvas UI4OKPrimary Nexus canvas. Autonomous demo mode controller (window.nexusAuto); BL19–BL22 in progress.
NEXUS_BACKLOG.htmlPlatform5OKFeature backlog BL01–BL25. Not authoritative for priorities; see ACTION_PLAN.
NEXUS_DEMO_VISION.htmlPlatform2OKAutonomous demo mode vision. Governs BL19–BL25 implementation. Defines controller spec, data templates, RBAC form generation.
architecture.htmlNexus RefOKNexus rule engine architecture reference. Site-nav added 2026-04-19.
data-model.htmlNexus RefOKNexus data model reference. Site-nav added 2026-04-19.
production-readiness.htmlNexus RefOKNexus production readiness reference. Site-nav added 2026-04-19.
NEXUS_APP_REQUIREMENTS.htmlHub Dashboard1OKAS-1 Requirements — 35 requirements across 7 sections from AS-0 Primarch sessions. First formal requirements capture for NeXus App. Implementation status tracked per requirement.
NEXUS_APP_SPEC.htmlHub Dashboard4OKHub Dashboard specification. User stories, click sequences, acceptance criteria, data model. SPEC-HUB-01 v1.0.
NEXUS_APP_STYLING.htmlHub Dashboard4OKHub Dashboard design system. 6-skin theme engine, glassmorphism, typography, colour tokens, animations. STY-HUB-01 v1.0.
NEXUS_APP_USER_MANUAL.htmlHub Dashboard5OKHub Dashboard end-user manual. Login, hub navigation, workspace usage, forms, FAB, troubleshooting. MAN-HUB-01 v1.0.
NEXUS_APP_MOCKUPS.htmlHub Dashboard4OKHub Dashboard layout mockups. Interactive wireframes for login, hub, workspace, form, run log screens. MOCK-HUB-01 v1.0.
06Archived Files

The following 14 files were archived to docs/archive/. 12 HTML files archived on 2026-04-19; 2 Markdown files archived on 2026-05-03.

FileFormer CategoryReason for Archive
hld.htmlOrphanSuperseded by NEXUS_HLD.html. No unique content.
wbs.htmlOrphanSuperseded by NEXUS_WBS.html. No unique content.
roadmap.htmlOrphanSuperseded by NEXUS_PRODUCT_PLAN.html. No unique content.
SPRINT_PLAN.htmlNexus LegacyNexus-era sprint plan. EXP-1 context now in NEXUS_ACTION_PLAN.html.
CZ_USECASE_NEXUS.htmlNexus LegacyCode Zero Nexus use case. Superseded by NEXUS use cases.
UV_PRODUCT_PAGE_NEXUS.htmlNexus LegacyNexus product page. Superseded by NEXUS_PRODUCT_PLAN and NEXUS_LEAFLET.
NEXUS_OVERVIEW.htmlNexus LegacyNexus platform overview. Core principles captured in active architecture docs.
NEXUS_PLATFORM.htmlNexus LegacyNCDW platform doc. Concepts captured in NEXUS_HLD.html and NEXUS_PRODUCT_PLAN.html.
EXP1_ARCHITECTURE.htmlExperimentEXP-1 architecture detail. Engineering results captured in NEXUS_ACTION_PLAN.html.
EXPERIMENT_1_REPORT.htmlExperimentEXP-1 sprint report. Results summarised in NEXUS_ACTION_PLAN.html.
EXPERIMENT_2_REPORT.htmlExperimentEXP-2 GPU benchmark. Results summarised in NEXUS_ACTION_PLAN.html.
EXPERIMENT_3_REPORT.htmlExperimentEXP-3 bulk write-back validation. Results summarised in NEXUS_ACTION_PLAN.html.
ARC_BUILD_PLAN.mdARC LegacySuperseded by NEXUS_ARC_PIPELINES.html and seed_arc_pipeline.py. Marked SUPERSEDED in header. Archived 2026-05-03.
ARC_REQUIREMENTS.mdARC LegacySuperseded by NEXUS_ARC_REQUIREMENTS.html (full HTML spec with FUNC-* requirement IDs). Archived 2026-05-03.