Repository navigation
docs(platform): Platform SDK reference review and docs pipeline fixes - #343
Merged
Merged
Conversation
- JSDoc review of createPlatformClient, chat, createPlatformServer, webhooks, and the error classes. - PlatformEvent is an explicit union (AppEvent and UnknownEvent), and gen-events.mjs generates its members and checks them for drift. - Pipeline: a Throws section isn't swallowed by Returns, consecutive Throws merge into one list, a returned type alias's page isn't inlined, a page can hold several type groups, error codes show in accordions under the error's code field, the SDKs dropdown target with nested reference groups, and reference groups start collapsed. - Platform SDK: errors move onto their module pages, and the type conversion depth is 5 so callback types aren't cut. - sdk-docs-writing: serial comma and App SDK and Platform SDK naming. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.54-pr.343.fe53e54Prefer not to change any import paths? Install using npm alias so your code still imports npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.54-pr.343.fe53e54"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.54-pr.343.fe53e54"
}
}
Preview published to npm registry — try new features instantly! |
Contributor
🚀 Package Preview Available! (
|
abrahams-wix
self-requested a review
October 20, 2026 11:41
abrahams-wix
approved these changes
Oct 20, 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
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.
Review of the Platform SDK reference, and the docs pipeline fixes it needed. The generated pages are in base44-dev/mintlify-docs#2641, so this should merge before or with it. Otherwise the next
create-docsrun frommainputs the old wording back.Platform SDK JSDoc
createPlatformClient,chat,createPlatformServer,webhooks, and the error classes: clearer descriptions,Throwsas full sentences that name the error, parentheses on function names, serial commas, and "the AI" or "test event" where the text said "builder" or "activation probe".onSnapshotno longer says to merge snapshot messages by ID. A snapshot replaces what you hold, and after an undo the SDK rejoins for a fresh one.Types
PlatformEventis an explicit union ofAppEvent<"…">members plusUnknownEvent, both new exported interfaces, in place of the mapped type that rendered with ellipses.gen-events.mjswrites the members between markers, and--checkfails if they drift from the AsyncAPI document.maxTypeConversionDepthis 5 intypedoc.mintlify.json, so callback types such asPromise<void | Response>aren't cut.Docs pipeline (shared with the App SDK)
Throwssection is no longer swallowed by a rewrittenReturns.Throwssections merge into one heading with a list.Returnsno longer inlines a returned type alias's whole page. The App SDK's actors workaround for the same bug now always fixes itsActorReflink.nested, which shows them in an accordion under the previous type'scodefield. The Platform SDK error codes use this.copy-to-local-docsfinds a reference group nested inside a per-SDK group, for the new SDKs dropdown, and generated reference groups start collapsed.App SDK output: the only changes are one
Throwssection that used to be dropped (auth), one restoredReturnsdescription (actors), and fiveThrowsheadings onintegrations.custom.call()merged into one list. The build warnings are unchanged.Platform SDK docs config
Errors move onto their module pages (
chat,webhooks), with no Errors nav group. Both packages target the SDKs dropdown.Skills
sdk-docs-writinggains the serial comma rule and App SDK and Platform SDK naming.Checks
npm test -w @base44/platform: types, 155 unit, docs with no warnings, and 9 package tests.npm run check:events: up to date.npm run create-docs -w @base44/sdk: same 11 warnings asmain.🤖 Generated with Claude Code