Skip to content

docs(platform): add @base44/platform/react to the Mintlify reference - #338

Merged
amitbardos merged 4 commits into
mainfrom
amitb/platform-react-docs
Oct 19, 2026
Merged

amitbardos merged 4 commits into
mainfrom
amitb/platform-react-docs

Conversation

@amitbardos

Copy link
Copy Markdown
Contributor

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.ts re-exports src/react beside the client and server.
  • types-to-expose.json and appended-articles.json give the hook four pages, with their helper types appended:
    • useBase44Chat: Base44ChatOptions, Base44Chat, ChatStatus, ChatConnection, ChatError
    • Base44ChatBackend: Base44App, ToolCallAnswer
    • ChatItem: ChatStep, ChatAnswer
    • ChatQuestion: ChoiceQuestion, ChoiceEntry, SecretsQuestion, SecretField, ApprovalQuestion, ApprovalDetails
  • typedoc.mintlify.json: the client also exports a generated SecretField (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 in intentionallyNotExported.
  • chat.types.ts: two JSDoc links pointed at Base44Chat.error, which has no page once appended to useBase44Chat; they link to the hook now. No API change.

Placement

Groups come from the page kind, in the pipeline shared with @base44/sdk: useBase44Chat lands in Clients beside createPlatformClient, 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/platform builds with no warnings, and every link on the React pages resolves. npm test -w @base44/platform and npm run lint pass.

The generated pages go to mintlify-docs in a separate PR.

🤖 Generated with Claude Code

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>
@github-actions

github-actions Bot commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

🚀 Package Preview Available! (@base44/platform)


Install this PR's preview build with npm:

npm i @base44-preview/platform@0.3.0-pr.338.9cd34e2

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/platform:

npm i "@base44/platform@npm:@base44-preview/platform@0.3.0-pr.338.9cd34e2"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/platform": "npm:@base44-preview/platform@0.3.0-pr.338.9cd34e2"
  }
}

Preview published to npm registry — try new features instantly!

@github-actions

github-actions Bot commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.54-pr.338.9cd34e2

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.54-pr.338.9cd34e2"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.54-pr.338.9cd34e2"
  }
}

Preview published to npm registry — try new features instantly!

amitbardos and others added 3 commits October 19, 2026 17:33
# 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>
@amitbardos
amitbardos requested a review from ozsay October 19, 2026 14:35
@amitbardos
amitbardos merged commit 3f8b146 into main Oct 19, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants