Skip to content

Added LLM-based website docs validation section to CONTRIBUTING.md#39

Merged
sacOO7 merged 3 commits intomainfrom
feature/doc-update-release-process
Mar 3, 2026
Merged

Added LLM-based website docs validation section to CONTRIBUTING.md#39
sacOO7 merged 3 commits intomainfrom
feature/doc-update-release-process

Conversation

@sacOO7
Copy link
Copy Markdown
Contributor

@sacOO7 sacOO7 commented Feb 23, 2026

@github-actions github-actions Bot temporarily deployed to staging/pull/39/storybook February 23, 2026 08:04 Inactive
@sacOO7
Copy link
Copy Markdown
Contributor Author

sacOO7 commented Feb 23, 2026

@coderabbitai review

@sacOO7 sacOO7 marked this pull request as ready for review February 23, 2026 08:05
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds contributor guidance for validating website documentation React snippet accuracy against the SDK source, aligning with DX-485 and strengthening the release process checklist to include this verification when relevant.

Changes:

  • Added a “Validate website doc snippets” section with an LLM prompt/checklist for verifying react-annotated .mdx snippets in ably/docs against this SDK.
  • Updated/rewrapped the “Release Process” section and added new steps to run snippet validation and open/merge corresponding docs PRs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
… react-ui code snippets in the web documentation against the SDK source code.
@sacOO7 sacOO7 force-pushed the feature/doc-update-release-process branch from 0b17960 to c2c9850 Compare February 23, 2026 09:44
@github-actions github-actions Bot temporarily deployed to staging/pull/39/storybook February 23, 2026 09:45 Inactive
@splindsay-92
Copy link
Copy Markdown
Contributor

@sacOO7 this is very much needed, thanks for adding it! Can I also suggest we add a .claude file and related handling to the git workflows? We generally use claude here, so this will help automate changes for Ably developers :) Wdyt?

@sacOO7
Copy link
Copy Markdown
Contributor Author

sacOO7 commented Feb 23, 2026

@sacOO7 this is very much needed, thanks for adding it! Can I also suggest we add a .claude file and related handling to the git workflows? We generally use claude here, so this will help automate changes for Ably developers :) Wdyt?

Are you talking implementing something similar to this -> https://ably.atlassian.net/browse/DX-837

@splindsay-92
Copy link
Copy Markdown
Contributor

@sacOO7 this is very much needed, thanks for adding it! Can I also suggest we add a .claude file and related handling to the git workflows? We generally use claude here, so this will help automate changes for Ably developers :) Wdyt?

Are you talking implementing something similar to this -> https://ably.atlassian.net/browse/DX-837

Nice, this looks great!

Comment thread CONTRIBUTING.md Outdated
@github-actions github-actions Bot temporarily deployed to staging/pull/39/storybook February 24, 2026 05:52 Inactive
@sacOO7 sacOO7 requested a review from splindsay-92 February 24, 2026 05:55
@github-actions github-actions Bot temporarily deployed to staging/pull/39/storybook March 2, 2026 13:09 Inactive
Updated note to contributing.md to make sure ably-chat-react-ui-kit and ably-chat-react-ui-kit
SDK in sync with remote
Copy link
Copy Markdown
Contributor

@splindsay-92 splindsay-92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sacOO7 sacOO7 merged commit 5c0c505 into main Mar 3, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants