docs: refresh package READMEs, npm metadata, and repo social preview - #16
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.
Documentation and package-metadata pass over the three published wrappers. No
source, build, or release behaviour changes.
What changed
packages/react/README.md— quick start for bothSeatingChartandSeatPicker, security boundary, architecture note, complete callback-prop andimperative-handle lists, FAQ, and the shared SDK ecosystem table.
packages/vue/README.md,packages/angular/README.md— same structure, plusthe chart inputs, outputs, and handle methods that the tables were missing
(
initialView,errorDisplay,buyerAccessTokenProvider,buyerAccessToken, the three buyer-access events, andrefreshAccess).README.md— rewritten around the three published packages, with thesecurity and public/private boundaries, an FAQ, and the ecosystem table.
packages/*/package.json—descriptionandkeywordsaligned across thethree packages.
.github/social-preview.png— 1280x640 repository social card.Verification
Every documented prop, event, and method was read out of the source before it
was written down:
SEATING_CHART_HANDLE_METHODS/SEATING_CHART_IDENTITY_PROPSin@seatlayer/jspackages/vue/src/SeatingChart.tspackages/angular/src/seating-chart.component.tspackages/react/src/{SeatingChart,SeatPicker}.tsxpackage.jsonexportsEvery non-npm link in the changed files returns HTTP 200; npm package pages
return 403 to curl (bot protection).
No version bump and no release: the README changes reach npm with the next
scheduled wrapper release.
The social preview cannot be set through the API — it needs to be uploaded once
under Settings -> General -> Social preview.