Open
Conversation
github-actions
bot
temporarily deployed
to
staging/pull/37/storybook
github-actions
bot
temporarily deployed
to
staging/pull/37/storybook
sacOO7
force-pushed
the
feature/storybook-api-documentation
branch
from
71d457c to
e663c12
Compare
github-actions
bot
temporarily deployed
to
staging/pull/37/storybook
Author
|
@coderabbitai review |
There was a problem hiding this comment.
Pull request overview
This PR adds API documentation publishing via a new GitHub Actions workflow and improves the README with installation, usage examples, and documentation links.
Changes:
- Expanded README with additional SDK/API documentation links, updated installation instructions, and two React usage examples (full app and component-level usage).
- Added a new
.github/workflows/docs.ymlworkflow to build Storybook (npm run build-storybook) and upload the generated static site to the SDK docs infrastructure using AWS credentials andably/sdk-upload-action.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds links to SDK, API docs, and example apps, updates the install command to include the ably package, and documents end-to-end usage patterns with App, Sidebar, and ChatWindow examples. |
| .github/workflows/docs.yml | Introduces an API Reference workflow that builds Storybook on pushes/PRs and uploads the storybook-static output to the central docs hosting, guarded by repository and actor checks for secret use. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Added missing API doc and other doc links for react ui kit - Updated installtion section to have ably as an explicit dependency - Added usage section for the recommended components
sacOO7
force-pushed
the
feature/storybook-api-documentation
branch
from
e663c12 to
2743d33
Compare
splindsay-92
approved these changes
Feb 5, 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
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.
npm run build-storybook