LearnNewsExamplesServices
Frontmatter
id7664
titleDocs: Create Codebase Overview Guide
stateClosed
labels
documentationenhancementai
assigneestobiu
createdAtOct 26, 2025, 2:53 PM
updatedAtOct 26, 2025, 5:10 PM
githubUrlhttps://github.com/neomjs/neo/issues/7664
authortobiu
commentsCount0
parentIssue7665
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtOct 26, 2025, 5:10 PM

Docs: Create Codebase Overview Guide

Closed v11.0.0 documentationenhancementai
tobiu
tobiu commented on Oct 26, 2025, 2:53 PM

As part of the agent protocol simplification epic (#7604), we need a new guide to provide a high-level conceptual map of the Neo.mjs codebase. This guide will replace the need for the agent to parse the large class-hierarchy.yaml file for initial discovery.

Acceptance Criteria:

  1. Create a new file at learn/guides/fundamentals/CodebaseOverview.md.
  2. The guide should explain the "batteries included" philosophy of the framework.
  3. It must provide a high-level overview of the major namespaces within the src directory (e.g., component, data, form, grid, manager, worker, etc.), explaining their purpose and how they relate to each other.
  4. Add the new guide to learn/tree.json under the "Fundamentals & Core Concepts" section.
tobiu added the documentation label on Oct 26, 2025, 2:53 PM
tobiu added the enhancement label on Oct 26, 2025, 2:53 PM
tobiu added the ai label on Oct 26, 2025, 2:53 PM
tobiu assigned to @tobiu on Oct 26, 2025, 2:54 PM
tobiu added parent issue #7665 on Oct 26, 2025, 2:54 PM
tobiu referenced in commit b7da67b - "Docs: Create Codebase Overview Guide #7664 draft version" on Oct 26, 2025, 3:19 PM
tobiu referenced in commit 9ae4dcb - "#7664 final version" on Oct 26, 2025, 4:22 PM
tobiu closed this issue on Oct 26, 2025, 5:10 PM