What is the Neural Link?

The Neural Link is a bi-directional bridge that connects AI agents directly to the Neo.mjs runtime. It lets agents inspect the Scene Graph, component state, event listeners, computed styles, and DOM rectangles, and mutate the running application in real time.

Why is Neo.mjs called an Application Engine instead of a framework?

Neo.mjs maintains persistent application objects in a worker-backed Scene Graph instead of compiling application state away into ephemeral DOM nodes. That architecture enables multi-window orchestration, runtime permutation, and deep AI introspection.

What is Context Engineering?

Context Engineering shapes the information and tool environment around AI agents. Neo.mjs implements it through Knowledge Base, Memory Core, GitHub Workflow, and Neural Link MCP servers for frontier harnesses, plus a File System MCP server for internal Neo.ai.Agent local loops.

What is the Neo.mjs Agent OS?

The Neo.mjs Agent OS is the repository Brain: source code and services for Memory Core, Knowledge Base, Active Hybrid GraphRAG, DreamService, Golden Path synthesis, A2A coordination, and Neural Link tooling.

Frontmatter

id	8065
title	Enhance Source Code with Intent-Driven Documentation
state	Closed
labels	documentationairefactoring
assignees	tobiu
createdAt	Dec 9, 2025, 2:19 AM
updatedAt	Dec 9, 2025, 2:28 AM
githubUrl	https://github.com/neomjs/neo/issues/8065
author	tobiu
commentsCount	1
parentIssue	null
subIssues	[]
subIssuesCompleted	0
subIssuesTotal	0
contentTrust
projected
quarantined	0
signals	[]
blockedBy	[]
blocking	[]
closedAt	Dec 9, 2025, 2:28 AM

Enhance Source Code with Intent-Driven Documentation

Closed v11.17.0/archive-v11-17-0-chunk-1 documentationairefactoring

tobiu commented on Dec 9, 2025, 2:19 AM

Apply the "Knowledge Base Enhancement Strategy" to the recently refactored and touched files to improve discoverability and AI context.

Files to Enhance:

src/code/LivePreview.mjs
src/code/renderer/Base.mjs
src/code/renderer/Neo.mjs
src/code/renderer/Markdown.mjs
apps/portal/view/learn/ContentComponent.mjs

Action Plan:

Analyze: Review each file to identify key mechanisms, architectural roles, and patterns.
Document: Add structured JSDoc comments to classes and key methods using the @summary tag and detailed descriptions.
Semantic Signposting: Explicitly mention relevant concepts (e.g., pluggable renderer, dynamic import, markdown parsing) to aid future queries.

Goal: Ensure the new renderer architecture is well-documented for both human developers and future AI sessions.

tobiu Dec 9, 2025, 2:27 AM

Input from Gemini:

✦ Enhancement complete.

Documentation Updates:

src/code/LivePreview.mjs:

Class: Documented the pluggable renderer architecture, dynamic imports, and component features.

loadRenderer: Explained the lazy-loading strategy and caching mechanism for performance.

doRunSource: Detailed the execution orchestration (validation, cleanup, delegation, state update).

src/code/renderer/Base.mjs:

Class: Defined its role as the abstract Strategy interface for polymorphism.

src/code/renderer/Neo.mjs:

Class: Documented its role in executing Neo.mjs code dynamically.

render: Detailed the complex logic for import rewriting, environment-aware path adjustments, sandbox execution via new Function, and namespace cache clearing for HMR.

src/code/renderer/Markdown.mjs:

Class: Described the extended Markdown processing capabilities.

render: Explained the multi-pass pipeline (Extraction -> Highlighting -> Parsing -> Injection) required to handle mixed content (static markdown + dynamic components) and async highlighting.

apps/portal/view/learn/ContentComponent.mjs:

Class: Clarified its responsibility as the documentation viewer and delegator to the Markdown renderer.

Intent-driven comments explaining the "why" behind key architectural decisions have been applied.