docs(actors): update JSDoc for actors SDK module - #289
Open
abrahams-wix wants to merge 9 commits into
Open
abrahams-wix wants to merge 9 commits into
abrahams-wix wants to merge 9 commits into
Conversation
Rewrites JSDoc across actors.types.ts to align with established terminology and writing style: session vs instance, client vs page, incoming/outgoing message direction, and full @param/@returns/@example coverage on all public methods. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
🚀 Package Preview Available!Install this PR's preview build with npm: npm i @base44-preview/sdk@0.8.49-pr.289.e36026dPrefer 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.49-pr.289.e36026d"Or add it to your {
"dependencies": {
"@base44/sdk": "npm:@base44-preview/sdk@0.8.49-pr.289.e36026d"
}
}
Preview published to npm registry — try new features instantly! |
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
docs-draft
- Use 'session' consistently instead of 'instance' throughout descriptions - Replace implementation-focused comments with developer-facing language - Add links to sample flows, overview concepts, and types generate CLI command - Simplify field and method descriptions per style guide Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
… pages Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…mple Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Replace {link} cross-references with anchor links for types appended to the same page
- Rewrite ActorsModule intro to lead with client capabilities
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…k line Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
wixysam
reviewed
Sep 23, 2026
wixysam
left a comment
wixysam
left a comment
Collaborator
There was a problem hiding this comment.
Pretty large. I did some spot checks and it looks fine. Just one thing:AppPublicSettingsResponse is in the nav. I don't think it should be.
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.
Summary
actors.types.tsto align with established terminology and writing style@param,@returns, and@examplecoverage on all public methods🤖 Generated with Claude Code