Repository navigation
Clarify example modules and deploy documentation independently - #134
Merged
Merged
Conversation
|
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
Separate the README and complete RPC, HTTP, React, and tracing examples into named modules with real imports. Preserve ready-client acquisition and cleanup, and verify snippets against compiled fixtures.
Deploy documentation after successful validation on main, independently of npm publication. Keep an
npmfallback until the existing registry lookup supplies the published version.Evidence
After: named modules show their ownership and imports; public fixtures compile under TypeScript 7 and 5.9.
After: deployment reuses the validated documentation artifact; seven Chromium checks pass, including published-version and registry-failure cases.
Merge Danger
Door: two-way
The changes can be reverted. After merge, validated main documentation deploys even when npm publication is skipped or fails. Publishing setup and public library behavior are unchanged.
Blast Radius: Documentation