Skip to content

docs: Pages site accuracy fixes + tools-table drift guard#59

Merged
TMHSDigital merged 2 commits into
mainfrom
docs/pages-review
Jul 3, 2026
Merged

docs: Pages site accuracy fixes + tools-table drift guard#59
TMHSDigital merged 2 commits into
mainfrom
docs/pages-review

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Summary

From a Playwright review of the live GitHub Pages site:

  • Corrected a factual error: the Windows notes claimed window capture matches "by exact title"; the real behavior (per src/utils/windows.ts and mcp-tools.json) is case-insensitive exact first, then substring, topmost match wins.
  • Heading anchors: ids on all <h2>s so deep links like #tools work (previously dead).
  • Favicon: inline SVG data URI — removes the 404 that was the page's only console error.
  • 0.9.0 overwrite note: one sentence above the tools table documenting that tools refuse to replace an existing file at a caller-supplied output path without overwrite: true.
  • OG/Twitter meta tags so shared links unfurl.
  • New drift guard (src/__tests__/docs.test.ts): asserts the site's tools table and mcp-tools.json list exactly the same tool names, both directions. The table is hand-mirrored and nothing else checks it.

No version bump: docs and tests are not part of the published package (precedent: #49), and release.yml skips the already-tagged v0.9.0. Merging auto-triggers the Pages deploy (pages.yml fires on docs/**).

Testing

  • Full gate green: build, typecheck, lint, 162 passed / 6 skipped — including the new docs-sync test.
  • Negative check: deleting the reframe row makes the drift test fail with "tools missing from docs/index.html: reframe"; restored, it passes.
  • Post-merge: will verify the live site (anchor scroll, zero console errors, corrected text) once Pages redeploys.

🤖 Generated with Claude Code

TMHSDigital and others added 2 commits July 3, 2026 12:52
- Correct the window-capture note: matching is case-insensitive exact
  first, then substring, topmost match wins (was: "exact title" only).
- Add heading ids so deep links like #tools work.
- Inline SVG favicon (was a 404 console error on every load).
- Note the 0.9.0 overwrite-refusal behavior above the tools table.
- Open Graph / Twitter meta tags for link unfurls.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The table is hand-mirrored with no check; this fails CI when a tool is
added/removed without updating docs/index.html, or when the site lists
a tool that is not registered.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 3, 2026
@TMHSDigital TMHSDigital merged commit 39af852 into main Jul 3, 2026
8 checks passed
@TMHSDigital TMHSDigital deleted the docs/pages-review branch July 3, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant