Repository navigation
docs(platform): add @base44/platform/react to the Mintlify reference - #338
Merged
Merged
Conversation
The reference entry now re-exports /react beside the client and server, so the pipeline builds its pages from the JSDoc like the rest of the package: useBase44Chat (with its options and return types), Base44ChatBackend, ChatItem (with ChatStep and ChatAnswer) and ChatQuestion (with each kind). - The client also exports a generated SecretField, a socket shape no page shows; the reference documents the React one and marks the generated one as intentionally not exported. - Two JSDoc links pointed at a member of Base44Chat, which has no page of its own once appended to useBase44Chat; they link to the hook now. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
🚀 Package Preview Available! (
|
Contributor
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.54-pr.338.9cd34e2Prefer 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.338.9cd34e2"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.54-pr.338.9cd34e2"
}
}
Preview published to npm registry — try new features instantly! |
# Conflicts: # packages/platform/scripts/mintlify-post-processing/types-to-expose.json
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ozsay
approved these changes
Oct 19, 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.
Adds the React hook released in 0.3.0 (#315) to the package's Mintlify reference, through the existing pipeline.
What
scripts/mintlify-post-processing/reference.tsre-exportssrc/reactbeside the client and server.types-to-expose.jsonandappended-articles.jsongive the hook four pages, with their helper types appended:useBase44Chat:Base44ChatOptions,Base44Chat,ChatStatus,ChatConnection,ChatErrorBase44ChatBackend:Base44App,ToolCallAnswerChatItem:ChatStep,ChatAnswerChatQuestion:ChoiceQuestion,ChoiceEntry,SecretsQuestion,SecretField,ApprovalQuestion,ApprovalDetailstypedoc.mintlify.json: the client also exports a generatedSecretField(a socket shape no page shows). The flat entry would make the two ambiguous, so the reference documents the React one and lists the generated one inintentionallyNotExported.chat.types.ts: two JSDoc links pointed atBase44Chat.error, which has no page once appended touseBase44Chat; they link to the hook now. No API change.Placement
Groups come from the page kind, in the pipeline shared with
@base44/sdk:useBase44Chatlands in Clients besidecreatePlatformClient, and the three type pages in Modules. A separate React group would need a change to the shared post-processing, so it isn't here.Tested
npm run create-docs -w @base44/platformbuilds with no warnings, and every link on the React pages resolves.npm test -w @base44/platformandnpm run lintpass.The generated pages go to mintlify-docs in a separate PR.
🤖 Generated with Claude Code