Repository navigation
Document every source API with checked examples - #18
Merged
Merged
Conversation
ConsoleTVs
marked this pull request as ready for review
October 24, 2026 12:57
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
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.
Summary
Documentation only. Every substantive named declaration and member has a useful description and a checked
@example, includingQuery.resourceand its retain/release protocol. Correct misleading refetch, generator cleanup, event payload, configuration, and unpublished Solid import examples. No changes to skills, AGENTS.md, signatures, or runtime behavior.Evidence
After: 218/218 documented with examples, including 147/147 public and 71/71 private declarations/members/state bindings. Existing contextual locals are excluded from the example requirement.
npm test: 113 tests pass.npm run lint,npm run format:check,git diff --check: clean.npm run build: succeeds, with the existing TS2786 Solid/React JSX diagnostic printed by both declaration plugins. The broad project typecheck also retains that baseline diagnostic; isolated source/example programs are clean.Merge Danger
Door: two-way
Comments only; reverting restores the former reference material without changing behavior.
Blast Radius: documentation
Published declarations gain richer comments. Existing type-overload and unfinished Solid limitations are documented rather than changed.