LearnNewsExamplesServices
Frontmatter
id7237
titleFormalize Agent & Documentation Standards
stateClosed
labels
enhancement
assigneestobiu
createdAtSep 23, 2025, 3:31 PM
updatedAtSep 23, 2025, 3:32 PM
githubUrlhttps://github.com/neomjs/neo/issues/7237
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtSep 23, 2025, 3:32 PM

Formalize Agent & Documentation Standards

Closed v10.9.0 enhancement
tobiu
tobiu commented on Sep 23, 2025, 3:31 PM

Description

To address a recurring failure in correctly documenting reactive configs, a series of enhancements were made to the agent protocol and project guidelines to create an explicit, enforceable standard.

This ensures that all AI-driven contributions adhere to the framework's core conventions, moving from an assumed understanding to a documented, systemic process.

Changes

  1. CODING_GUIDELINES.md Updated:

    • A new "JSDoc for Configs" section was added.
    • This section explicitly defines the mandatory use of the @reactive tag for reactive configs (those ending in _).
    • It also clarifies the correct, limited use of the @protected tag for internal configs only.
  2. AGENTS.md Updated:

    • The "Session Initialization" process was updated with a new mandatory step: the agent MUST read .github/CODING_GUIDELINES.md at the start of every session.
    • A CRITICAL note was added to the core.Base.mjs reading step, forcing the agent to focus on the technical implementation of the reactive config system.

Impact

This work creates a permanent, explicit source of truth for documentation standards and makes adherence to them a non-negotiable part of the agent's core workflow. It fundamentally improves the reliability and consistency of all future AI contributions.

tobiu assigned to @tobiu on Sep 23, 2025, 3:31 PM
tobiu added the enhancement label on Sep 23, 2025, 3:31 PM
tobiu referenced in commit a147355 - "Formalize Agent & Documentation Standards #7237" on Sep 23, 2025, 3:32 PM
tobiu closed this issue on Sep 23, 2025, 3:32 PM