LearnNewsExamplesServices
Frontmatter
id7432
titleRefine and Align Core Project Documentation (VISION.md & README.md)
stateClosed
labels
documentation
assigneestobiu
createdAtOct 10, 2025, 12:45 AM
updatedAtOct 10, 2025, 12:46 AM
githubUrlhttps://github.com/neomjs/neo/issues/7432
authortobiu
commentsCount0
parentIssue7264
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtOct 10, 2025, 12:46 AM

Refine and Align Core Project Documentation (VISION.md & README.md)

Closed v11.0.0 documentation
tobiu
tobiu commented on Oct 10, 2025, 12:45 AM

This ticket documents a comprehensive effort to refine and align the project's core strategic and introductory documents: VISION.md and README.md. The goal was to increase clarity, strengthen architectural claims with proof, and ensure the messaging is both powerful and timeless.

VISION.md Refinements

The vision was updated to be more explicit about its foundational architectural principles, making it more credible and defensible without losing its inspirational tone.

  • Performance Pillar: The claim of "elite performance" was substantiated by making a bold, direct statement about order-of-magnitude performance improvements and linking it directly to the benchmark blog post as evidence.
  • Architectural Principles: The core philosophies were woven directly into the narrative, including:
    • The Actor Model as the solution to the "tyranny of the main thread."
    • The JavaScript-first approach (persistent instances projecting the UI).
    • The VDOM as a lightweight, necessary protocol for any true multi-threaded architecture.
  • AI Pillar: The connection between the JSON Blueprint and its real-world application was strengthened by hinting at the orchestration of multi-window interfaces.
  • Clarity: The "Zero-Builds Workflow" was clarified to apply specifically to the development experience.

README.md Refinements

The README was updated to be more evergreen, more precise, and better integrated with the project's strategic documents.

  • Timeless Messaging: All references to "v10" were removed from headers and feature descriptions to ensure the document does not become dated.
  • Strategic Alignment: A new "Vision & Roadmap" section was added to provide a clear path for developers to understand the project's long-term goals.
  • AI Strategy: The "AI-Native by Design" section was replaced with a more professional and specific explanation of Context Engineering, articulating the deliberate system being built to enable AI collaboration while carefully preserving all links to existing guides.
tobiu assigned to @tobiu on Oct 10, 2025, 12:45 AM
tobiu added the documentation label on Oct 10, 2025, 12:45 AM
tobiu added parent issue #7264 on Oct 10, 2025, 12:45 AM
tobiu referenced in commit 670d0b3 - "Refine and Align Core Project Documentation (VISION.md & README.md) #7432" on Oct 10, 2025, 12:46 AM
tobiu closed this issue on Oct 10, 2025, 12:46 AM