What is the 'Neural Link'?

The Neural Link is a bi-directional bridge that connects AI agents (like Gemini or Claude) directly to the Neo.mjs runtime. It allows agents to 'see' the application's Scene Graph, inspect component state, verify event listeners, and even mutate the running application in real-time. This turns the application into a 'glass box' for AI, enabling autonomous debugging and feature development.

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

Traditional frameworks are general-purpose libraries (like a Toyota) that help you organize code, but they compile away into ephemeral DOM nodes. Neo.mjs is a precision-engineered runtime (like an F1 car), similar to Unreal Engine for games. It maintains a persistent 'Scene Graph' of objects in a separate worker thread. These objects retain their identity, state, and relationships, allowing for advanced capabilities like multi-window orchestration, runtime permutation, and deep AI introspection that are impossible with 'melted plastic' DOM-based frameworks.

What is 'Context Engineering'?

Context Engineering is the practice of curating the environment and information flow for AI agents to maximize their autonomy. In Neo.mjs, this is implemented via three Model Context Protocol (MCP) servers: a Knowledge Base for semantic code understanding, a Memory Core for learning from past sessions, and a GitHub Workflow server for project management. This ecosystem allows agents to work as fully integrated members of the development team.

What is 'Object Permanence' in the context of Neo.mjs?

In Neo.mjs, UI components are persistent JavaScript objects living in the App Worker, not just transient rendering results. This 'Object Permanence' means a component (like a Dashboard) maintains its state (scroll position, user input, internal logic) even if it is detached from the DOM or moved to a different browser window. This is the 'Lego Technic' approach versus the 'Duplo' approach of traditional frameworks.

What is an 'Agent Operating System'?

Neo.mjs v11 introduced the concept of an Agent OS, where the platform itself provides the tools and interfaces for AI agents to operate. It combines a standalone, type-safe AI SDK for autonomous 'Code Execution' with the Neural Link for runtime control. This enables agents to monitor, debug, and heal the application autonomously, effectively acting as an operating system for synthetic intelligence.

How does Neo.mjs handle multi-window applications?

Neo.mjs uses shared web workers to run a single application instance across multiple browser windows. All windows share the same application state and data in real-time. Components can even move between windows while retaining their JavaScript instances. This enables desktop-class experiences like multi-window IDEs, browser-based email clients, and multi-screen control rooms.

What makes Neo.mjs different from React, Angular, or Vue?

Neo.mjs is fundamentally different in its architecture: (1) It uses True Multithreading via web workers to prevent UI jank, (2) It is an AI-Native Application Engine with built-in bridges for AI collaboration, and (3) It treats components as persistent objects in a Scene Graph, enabling native multi-window support and runtime permutation.

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
blockedBy	[]
blocking	[]
closedAt	Dec 9, 2025, 2:28 AM

Enhance Source Code with Intent-Driven Documentation

Name: Neo.mjs Application Engine
Author: Neo.mjs

Closed v11.17.0 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 added the documentation label on Dec 9, 2025, 2:19 AM

tobiu added the ai label on Dec 9, 2025, 2:19 AM

tobiu added the refactoring label on Dec 9, 2025, 2:19 AM

tobiu assigned to @tobiu on Dec 9, 2025, 2:26 AM

tobiu referenced in commit 5f3317d - "Enhance Source Code with Intent-Driven Documentation #8065" on Dec 9, 2025, 2:27 AM

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.

tobiu closed this issue on Dec 9, 2025, 2:28 AM