LearnNewsExamplesServices
Frontmatter
id7157
titleUpdate and Refine Getting Started Documentation
stateClosed
labels
documentationenhancementdeveloper-experience
assigneestobiu
createdAtAug 2, 2025, 12:16 PM
updatedAtOct 23, 2025, 12:59 AM
githubUrlhttps://github.com/neomjs/neo/issues/7157
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtAug 2, 2025, 12:17 PM

Update and Refine Getting Started Documentation

Closed v10.3.0 documentationenhancementdeveloper-experience
tobiu
tobiu commented on Aug 2, 2025, 12:16 PM

Purpose

To enhance the getting started experience for new developers by updating and clarifying the core documentation.

Changes

1. Updated Browser Support Information

  • File: .github/GETTING_STARTED.md
  • File: .github/CONCEPT.md
  • File: examples/README.md
  • Change: Removed outdated references to "Chromium" and "Safari Tech Preview". The documentation now correctly states that the neo.mjs development mode is fully supported in all major modern browsers (Chrome, Edge, Firefox, Safari).

2. Restructured GETTING_STARTED.md

  • File: .github/GETTING_STARTED.md
  • Change: The guide is now split into two distinct paths:
    1. Creating an application (Recommended): Prioritizes and details the npx neo-app command for setting up a workspace.
    2. Contributing or Running Examples: Explains how to fork and clone the main repository, clarifying that this path is for framework contributors or those who want to run the included example apps.
  • Added: A new section at the end that links to the main learn/README.md to guide users toward further learning resources.

3. Enhanced learn/gettingstarted/Setup.md

  • File: learn/gettingstarted/Setup.md
  • Change:
    • Clarified that the npx neo-app script starts the development server by default.
    • Added a new section introducing the "Four Environments" concept, linking directly to the detailed learn/benefits/FourEnvironments.md guide. This gives new users early insight into one of Neo.mjs's core architectural advantages.
tobiu assigned to @tobiu on Aug 2, 2025, 12:16 PM
tobiu added the documentation label on Aug 2, 2025, 12:16 PM
tobiu added the enhancement label on Aug 2, 2025, 12:16 PM
tobiu added the developer-experience label on Aug 2, 2025, 12:16 PM
tobiu referenced in commit eeb17aa - "Update and Refine Getting Started Documentation #7157" on Aug 2, 2025, 12:17 PM
tobiu closed this issue on Aug 2, 2025, 12:17 PM