Skip to content

docs: fix stale (coming soon) markers + bring roadmap current (Cycle 19)#23

Merged
kbennett2000 merged 1 commit into
mainfrom
cycle-19-doc-drift
Jun 22, 2026
Merged

docs: fix stale (coming soon) markers + bring roadmap current (Cycle 19)#23
kbennett2000 merged 1 commit into
mainfrom
cycle-19-doc-drift

Conversation

@kbennett2000

Copy link
Copy Markdown
Owner

A quick-win correctness pass — no new page bodies, just stop the DONE work from claiming it's "coming." Fixes the drift the audit found.

Cycle spec: docs/cycles/cycle-19-doc-drift.md.

What changed

  • README — the developer-docs / quickstart lines said (coming soon), but the five docs/developers/* pages shipped in Cycle 17. Now they point at the live overview / quickstart / API / providers / bundles pages. The "no hosted demo yet" line is reworded so its (accurate) status no longer reads like a broken-link marker.
  • docs/roadmap.md — the worst drift: the table stopped at Cycle 12, mislabelled Cycles 8–11 "not merged", and omitted 13–18. Rewritten to the true merged history — every cycle 0–18 shown shipped (with PR + cycle-doc/ADR refs), the stale per-voice-cycle "validation pending" hedges removed (the authentic voice was confirmed end-to-end in Cycle 18), plus an honest "in progress / planned" section for the remaining doc work.
  • docs/characters.md — wired in the produced-but-unreferenced genie-animation.gif (a character actually in motion); removed genie-speaking.png as redundant with genie-speaking.gif.

Explicitly NOT touched

The genuine still-stub pages — getting-started, faq, troubleshooting, voice/overview, voice/setup, voice/sourcing-components — and their accurate (coming soon) signposts. Those get real content in later cycles.

Verification

Base main, not merged.

🤖 Generated with Claude Code

…e 19)

Correctness pass — no new page bodies, just stop DONE things claiming they're
coming:

- README: the developer-docs / quickstart lines said "(coming soon)" but the five
  docs/developers/* pages shipped in Cycle 17 — point at the live pages (overview,
  quickstart, API, providers, bundles). Reword the hosted-demo line so its accurate
  "no demo yet" status no longer reads like a broken-link/placeholder marker.
- roadmap.md: the worst drift. The table stopped at Cycle 12, mislabelled Cycles
  8-11 "not merged", and dropped 13-18. Rewritten to the true merged history —
  every cycle 0-18 shipped (PR + cycle-doc/ADR refs), the resolved voice
  "validation pending" hedges removed (authentic voice confirmed in Cycle 18), plus
  an honest "in progress / planned" section for the remaining doc work.
- characters.md: wire in the produced-but-unused genie-animation.gif (shows a
  character in motion). Remove genie-speaking.png as redundant with genie-speaking.gif.

Untouched (accurate signposts to genuine stubs): getting-started, faq,
troubleshooting, voice/* — those get real content in later cycles.

Docs only; no code. Links resolve, images render, CI green. Verified by
code-reviewer against the actual merge history.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kbennett2000 kbennett2000 merged commit 9eceb1e into main Jun 22, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant