Docs: Fix the index links, version claims, and missing migration entries - #519
Conversation
The widget example entry pointed at ./register-widget.md, but the file lives under ./examples/. The architecture-0.8.1 entry pointed at ./migration-0.7-to-0.8.1.md, a file that has never existed in this repo. Repoint it at the section of docs/architecture.md that already documents that refactor. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Three wrong version claims: the AI comment-only migration was labelled 0.11.0 when its own doc says 0.9.1, the activity-channel count read ten when eleven channels moved, and the channel rename was attributed to 0.9.9 when it ships in 1.0.0. migration-0.8.4-async-windowmanager.md and migration-ai-connectors.md existed but were unreachable from the index, so the async windowManager change and the AI connectors removal were undiscoverable for anyone starting at docs/README.md. Also renumbers the list. The source had a duplicate 4. and four 13., which is how a dead entry sat unnoticed. Markdown auto-numbers, so the rendered output does not change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
@claude can you review this? |
|
Claude finished @mmtr's task in 2m 19s —— View job Review complete ✅
I verified every claim in the PR description against the actual files:
Not independently verified: step 9 ( Nit (non-blocking): entry 4 ("Architecture") and entry 18 ("Architecture 0.8.1 layout") both point into Nothing else stood out — the changes are precise, scoped exactly to what the description promises, and consistent with the |
Proposed changes
Four fixes to
docs/README.md, the entry point plugin authors start from. Supersedes #518, which is folded in here.Two dead links.
./migration-0.7-to-0.8.1.md, a file that has never existed in this repo. Repointed at./architecture.md#architecture-081-layout-in-progress, which documents every item the entry describes: the path aliases, the registry / server-sync / api-client primitives, the public-API facade home, and the PHP slicing ofhelpers.php/components.php/render.php. Retitled to match its target../register-widget.md. The file is at./examples/register-widget.md.Three wrong version claims.
0.11.0. Its own doc says0.9.1.0.9.9. It ships in1.0.0. Corrected in the index and indocs/migration-activity-channels.md.Two migration notes were missing from the index entirely.
migration-0.8.4-async-windowmanager.mdandmigration-ai-connectors.mdboth exist but nothing linked them, so the asyncwindowManagerchange and the AI connectors removal were undiscoverable from the index.The list is renumbered. The source had a duplicate
4.and four13., so the visible numbering had drifted from the source. Markdown auto-numbers, so the rendered output is unchanged.Why are these changes being made?
docs/README.mdis the first thing a plugin author reads, and it was pointing at a file that does not exist, mislabelling three versions, and hiding two breaking-change notes. The duplicate source numbering is how the dead entry went unnoticed.Version numbers in migration entries are deliberate. AGENTS.md names
docs/migration-*.mdas the one exception to the no-version-annotations rule, because migration notes are version-anchored by design. The fix is to make them correct, not to remove them.Testing instructions
docs/README.mdand click through every link in the Index. Make sure none 404. This check catches the whole class:Make sure it prints nothing. On trunk it prints two lines.
docs/architecture.md, not the top of the file.docs/migration-ai-comment-only.mdand make sure its first line says 0.9.1, matching the index entry.docs/migration-activity-channels.md. Make sure the status line says 1.0.0 and the table lists eleven rows, both matching the index entry.grep -rn "0\.9\.9\|0\.11\.0" docs/ readme.txt. Make sure it returns nothing.docs/README.mdon GitHub and make sure the Index numbers run 1 to 24 with no repeats.npm run build. Make sure it leaves no diff.