LearnNewsExamplesServices
Frontmatter
id14493
titleFix README Quickstart dead links → portal learning-section URLs
stateClosed
labels
documentationenhancementai
assigneesneo-opus-grace
createdAtJul 2, 2026, 6:12 PM
updatedAtJul 2, 2026, 6:24 PM
githubUrlhttps://github.com/neomjs/neo/issues/14493
authorneo-opus-grace
commentsCount0
parentIssue14310
subIssues[]
subIssuesCompleted0
subIssuesTotal0
contentTrust
projected
quarantined0
signals[]
blockedBy[]
blocking[]
closedAtJul 2, 2026, 6:24 PM

Fix README Quickstart dead links → portal learning-section URLs

Closed v13.1.0/archive-v13-1-0-chunk-8 documentationenhancementai
neo-opus-grace
neo-opus-grace commented on Jul 2, 2026, 6:12 PM

Context

Operator-flagged (@tobiu, 2026-07-02): the README Quickstart is the worst section — every link is dead or rule-violating. "Every user that uses those links is a lost one forever."

The Rule (operator-stated)

README learning links may target ONLY:

  1. learn/ folder markdown (the LLM-readable view; GitHub-renders; never dies), OR
  2. The portal learning sectionhttps://neomjs.com/#/learn/<id> — the human-superior view (nav tree + live component previews + prev/next buttons).

NEVER dist/production (dead) and NEVER .github/ links for learning content.

Key invariant (V-B-A'd): every learn/**.md registered in learn/tree.json (and not hidden) is a live portal page at neomjs.com/#/learn/<tree.json id>. So tree.json membership = a guaranteed-live portal route. The tree.json id uses / separators (the old dead link used a stale .gettingstarted.Setup).

The Problem (audit)

Line Link Violation
126 Getting Started → .github/GETTING_STARTED.md .github/
127 Learning Section → …/dist/production/apps/portal/#/learn/gettingstarted.Setup dist/production + stale . separator
128 Examples → …/dist/production/apps/portal/#/examples dist/production; #/examples route no longer exists
129 AI Quick Start → .github/AI_QUICK_START.md .github/
130 Blog → …/dist/production/apps/portal/#/blog dist/production; #/blog route no longer exists

(Read Next lines 182-183 — VISION/STORY → .github/ — are a related but separate finding; those files physically live in .github/, so relocating them is out of this ticket's scope.)

The Fix

Rewrite the Quickstart CTAs as verified portal learning-section links (each id confirmed present in learn/tree.json):

  • Getting Startedhttps://neomjs.com/#/learn/gettingstarted/Setup (gettingstarted/Setup ✓)
  • Learning Sectionhttps://neomjs.com/#/learn (the hub — shows the nav tree)
  • What Is Neo?https://neomjs.com/#/learn/benefits/WhatIsNeo (benefits/WhatIsNeo ✓ — the canonical front-door intro; replaces a dead slot)
  • Run Your Own Agent Teamhttps://neomjs.com/#/learn/agentos/OwnAgentTeam (agentos/OwnAgentTeam ✓ — actual title "Provision Your Own Agent Team"; the accurate replacement for the stale .github KB-setup doc)

Examples + Blog dropped from the list: neither is in learn/tree.json and their old #/examples/#/blog routes are gone — so they are neither learn/ nor portal-learning content, and linking them would create new dead links. Re-add only once live routes are confirmed.

Acceptance Criteria

  • Quickstart contains zero dist/production and zero .github/ links.
  • Every learning link is either a learn/**.md relative path OR a neomjs.com/#/learn/<id> where <id> is present in learn/tree.json.
  • Each portal <id> V-B-A'd against learn/tree.json (membership = live route).
  • No link points to a route absent from the portal (#/examples, #/blog excluded until confirmed).

Out of Scope

  • Read Next VISION/STORY .github/ relocation (separate decision — those are project-meta, not learning content).
  • The broader codebase portal-URL inconsistency sweep (dist/esm, apps/portal/#/, #/ all appear across learn/blog/* + guides) — a follow-up #14310/#14327 leaf.

Related

  • Parent epic: #14310 (Documentation & learning-experience overhaul, v13.1).
  • learn/tree.json (portal learning-section SSOT).

Authored by Grace (@neo-opus-grace, Claude Opus 4.8). Operator-flagged (@tobiu).

tobiu referenced in commit 5869714 - "docs(readme): replace dead Quickstart links with portal learning URLs (#14493) (#14495) on Jul 2, 2026, 6:24 PM
tobiu closed this issue on Jul 2, 2026, 6:24 PM