LearnNewsExamplesServices
Frontmatter
titledocs: add Agent OS Architecture Overview guide (#9981)
authortobiu
stateMerged
createdAtApr 13, 2026, 7:58 PM
updatedAtApr 13, 2026, 8:09 PM
closedAtApr 13, 2026, 8:09 PM
mergedAtApr 13, 2026, 8:09 PM
branchesdevagent/9981-architecture-overview-guide
urlhttps://github.com/neomjs/neo/pull/9982
Merged
tobiu
tobiu commented on Apr 13, 2026, 7:58 PM

Summary

Adds a new top-level guide learn/agentos/ArchitectureOverview.md to the learning portal, providing a comprehensive architectural map of the Neo.mjs Agent OS. Registered as the first child of the "Agent OS & Conversational UIs" section in tree.json.

What This Guide Covers

  1. Two Hemispheres — How the frontend runtime engine and the Agent OS share a common class system
  2. Runtime Engine — Multi-worker architecture, triangular VDOM optimization, SharedWorker mode
  3. Agent OS — Cognitive loop (Perceive/Reason/Act/Reflect), SDK Bouncer pattern, five MCP servers
  4. Neural Link Bridge — WebSocket connection between Node.js agents and the live browser application
  5. Dream Pipeline — Six-phase REM pipeline including deterministic capability gap inference
  6. The Closed Loop — The self-improving feedback architecture that makes Neo unique
  7. Structural Inventory — Package-level reference tables for both hemispheres

Includes 6 Mermaid diagrams and cross-links to all sibling Agent OS guides.

Files Changed

  • [NEW] learn/agentos/ArchitectureOverview.md — The guide
  • [MODIFY] learn/tree.json — Added entry before Strategic Workflows

Architectural Impact

Closes a GUIDE_GAP for the Agent OS top-level namespace. The existing guides cover individual MCP servers but there was no entry point that ties the system together. This guide serves as the conceptual map for both human contributors and future agent instances.

Resolves #9981

tobiu
tobiu commented on Apr 13, 2026, 8:08 PM

Input from Claude Opus 4.6 (Antigravity):

❋ # PR Review Summary

Status: Approved (after self-correcting polish commit)

The guide provides a comprehensive, well-structured architectural map of the full Neo.mjs platform. During the review reflection phase, one bug was identified and fixed: the "Next Steps" cross-links were broken after the file was relocated from learn/agentos/ to learn/benefits/. A polish commit has been pushed.


📊 Evaluation Metrics

  • [ARCH_ALIGNMENT]: 92 - Accurately represents the two-hemisphere architecture, worker topology, and Agent OS cognitive loop. File placement was challenged mid-session and corrected from AgentOS to Benefits for discoverability.
  • [CONTENT_COMPLETENESS]: 90 - Comprehensive coverage of 7 sections with 6 Mermaid diagrams, 2 structural inventory tables, and cross-links. No JSDoc required (markdown guide). Cross-reference added to CodebaseOverview.
  • [EXECUTION_QUALITY]: 88 - Self-review caught broken cross-links from the relocation (all 6 ./ paths needed ../agentos/). Fixed in polish commit. All Mermaid diagrams use ASCII-safe labels (lesson learned from classDef graph reserved keyword issue).
  • [PRODUCTIVITY]: 95 - All three acceptance criteria from #9981 addressed: guide created, tree.json updated, cross-reference in CodebaseOverview added.
  • [IMPACT]: 65 - Closes a GUIDE_GAP for the platform-level architecture. High value for onboarding but no code changes.
  • [COMPLEXITY]: 30 - Documentation-only PR with 3 files touched. Low cognitive load.
  • [EFFORT_PROFILE]: Quick Win - High discoverability ROI for minimal complexity.

🕸️ Context & Graph Linking

  • Target Issue: Resolves #9981
  • Related Graph Nodes: DreamService, Neo.ai.Client, ContextAssembler, Agent.Loop
  • Origin Session: 70334eab-72c9-44a6-8f48-0b6a96604f49

🧠 Graph Ingestion Notes

  • [KB_GAP]: N/A — this PR closes a KB gap.
  • [TOOLING_GAP]: Mermaid's reserved keyword graph cannot be used as a classDef name. This caused a silent parse error. Future Mermaid diagrams should avoid graph, subgraph, end, direction as class identifiers.
  • [RETROSPECTIVE]: The placement challenge (AgentOS → Benefits) was the most valuable part of this PR. The user's instinct for discoverability over taxonomic purity is correct — in a tree-list sidebar, two clicks of nesting makes content invisible. This principle should be applied when creating future guides.

📋 Required Actions

None — all issues were caught and fixed during the reflection phase.

  • Guide relocated to learn/benefits/ArchitectureOverview.md
  • tree.json positions it as second child of Benefits (after Introduction)
  • Cross-reference added to CodebaseOverview.md
  • Cross-links fixed after relocation (./../agentos/)

LGTM — ready to merge.