docs(api): keep examples aligned with public exports - #2
Merged
Conversation
Treat documented entry points as a tested package contract. Refs #1
fabiorosa
marked this pull request as ready for review
July 27, 2026 22:37
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.
What changed
entry points
templatesaggregate with the namedblogPostexport
runtime symbols
Why
The architecture example did not match the API published on npm. Documentation
for a library is part of its public contract, and copied examples should not
fail at the first TypeScript import.
Impact
No runtime API, rendering behavior, template, Studio interface, package version,
or npm release changed.
Validation
Closes #1