Frontmatter
| id | 9500 |
| title | Epic: The Core Engine Learning Guides & Workshop |
| state | Closed |
| labels | documentationepicai |
| assignees | tobiu |
| createdAt | Mar 17, 2026, 9:49 AM |
| updatedAt | Mar 17, 2026, 12:06 PM |
| githubUrl | https://github.com/neomjs/neo/issues/9500 |
| author | tobiu |
| commentsCount | 2 |
| parentIssue | null |
| subIssues | [] |
| subIssuesCompleted | 0 |
| subIssuesTotal | 0 |
| blockedBy | [] |
| blocking | [] |
| closedAt | Mar 17, 2026, 12:06 PM |
Epic: The Core Engine Learning Guides & Workshop
tobiu assigned to @tobiu on Mar 17, 2026, 10:13 AM

tobiu
Mar 17, 2026, 10:19 AM
Input from Gemini 3.1 Pro:
✦ I have completed the creation of the core engine guides.
- Updated
learn/tree.jsonwith the new "The Core Engine" section (using thecoreenginefolder naming convention as instructed).- Created all 6 markdown files detailing the architecture:
WhyEnhance.md(constructvsconstructor)SetupClass.md(Class Compilation & prototype merging)ConfigSystem.md(Reactive configs &configSymbol)Reactivity.md(Push-based hooks vs Pull-based effects)Lifecycle.md(initAsync& remote methods)Utilities.md(core.Compare,delayable,core.Observable)The changes have been committed and pushed to
dev.

tobiu
Mar 17, 2026, 12:06 PM
Input from Gemini 3.1 Pro:
✦ I have finalized the Core Engine Learning Guides.
The guides have been significantly rewritten to form a cohesive narrative arc titled "The Journey of a Neo Class", moving away from isolated API documentation toward a structured, storytelling approach.
The guides now follow this logical progression:
- WhyEnhance.md: The problem with the vanilla JS
constructorand the introduction ofconstruct().- SetupClass.md: How the meta-compiler builds the class blueprint and reactive API.
- ConfigSystem.md: Tier 1 Reactivity (Push) and how the
configSymbolacts as a temporary holding zone to solve circular dependencies during batch updates.- Reactivity.md: Tier 2 Reactivity (Pull) and how
Effectspower cross-instance observation (Functional Components and State Providers).- Lifecycle.md: The asynchronous
initAsyncphase required for the distributed architecture.- Utilities.md: The low-level utilities (
core.Compare,delayable) that protect the engine's performance.Additionally, I updated the existing
StateProviders.mdguide to explicitly connect it to the newReactivity.mdconcepts, detailing the roles ofNeo.core.Effectand theHierarchicalDataProxy.All changes have been committed and pushed to the
devbranch.
tobiu closed this issue on Mar 17, 2026, 12:06 PM
This epic tracks the creation of a new set of learning guides focused on the "Neo Core Engine". These guides will form the basis of a 30-minute workshop but will also live permanently in the Portal App's learning section.
The goal is to explain why the Neo class system exists by contrasting it with vanilla JavaScript class limitations, and then deep-dive into its mechanics.
Motivation
Vanilla JS classes lack declarative configuration, automated reactivity, and a unified lifecycle. The Neo core addresses these missing pieces. Most developers are unaware of how powerful this environment-agnostic engine is (it powers not just the UI, but our Node.js AI infrastructure as well).
Content Structure & Sub-Tasks
We will add a new section to
learn/tree.jsoncalled "The Core Engine" underguides.constructvsconstructor)constructortrap in native JS (class fields initialized aftersuper()).Neo.create()andconstruct()solve this, ensuring the instance is fully formed before configuration.Neo.setupClass)setupClasswalks the prototype chain, mergesstatic config, and appliesNeo.overwrites.core.Config)trailing_underscore_convention).src/core/Base.mjsandsrc/core/Config.mjs: How theconfigSymbolacts as a temporary holding zone during batch updates (this.set({...})) to solve circular dependencies and make all new values available to hooks simultaneously.afterSet) with pull-based dependency tracking (src/core/Effect.mjs&src/core/EffectManager.mjs).initAsyncinitAsynccontrols theisReadyflag.src/core/Compare.mjs).buffer,debounce,throttle) inBase.mjs.core.Observable(linking to the existing guide).Implementation Plan
learn/tree.json.learn/guides/core_engine/.