Merged
Conversation
…/References Reorganizes README.md into the standard doc template while preserving all existing Command/Event API reference content, fixes a missing "Page visibility state" TOC entry, and flags a couple of unverified items (watch:sync's npm-utils dependency, absence of test files). Adds the docs:ai npm script and its prompt, and documents the new structure in CLAUDE.md for future reconciliation passes. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Author
|
/review |
The "Open modal" section linked to #json-modal, but the actual heading is "JSON modal action" (slug #json-modal-action). Found during a follow-up review of the README/CLAUDE.md restructure. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
tammesalu
approved these changes
Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Tickets & Documents
GRAL-5437
Description
Reorganizes
README.mdinto a standard doc template (Overview, Setup, Testing, Architecture, Endpoints (Commands & Events), References/Links) while validating it againstpackage.jsonandsrc/. All existing Command/Event API reference content (parameters, responses, examples) is preserved verbatim.Fixes/flags found during validation:
watch:sync'snpm-utilsdependency (not indevDependencies) and the current absence of test files as "Needs verification" rather than presenting them as verified/working.demo/,custom-modal-test/, andissue-63/are untracked local scratch dirs (not part of the repo) and excluded them from the docs.Also adds the
docs:ainpm script (invokes Claude Code headlessly with.claude/prompts/readme-docs.mdto reconcile the README against source) and its prompt file, and updatesCLAUDE.mdwith notes for future documentation reconciliation passes (anchor-slug stability across heading-level changes, no images to preserve yet, scratch dirs to ignore, etc).No changes to
src/or the public API — documentation only.Type of PR?
Manual testing
#anchorlinks).Command/Eventenum members, script names, and Node/npm version requirements againstsrc/types.tsandpackage.json.Automated tests added?