Added LLM-based website docs validation section to CONTRIBUTING.md#39
Added LLM-based website docs validation section to CONTRIBUTING.md#39
Conversation
sacOO7
commented
Feb 23, 2026
- Fixes https://ably.atlassian.net/browse/DX-485
- Added a new section in CONTRIBUTING.md with an LLM prompt to validate react-ui code snippets in the web documentation against the SDK source code.
|
@coderabbitai review |
There was a problem hiding this comment.
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.mdxsnippets inably/docsagainst 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.
… react-ui code snippets in the web documentation against the SDK source code.
0b17960 to
c2c9850
Compare
|
@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! |
… against source code repository
Updated note to contributing.md to make sure ably-chat-react-ui-kit and ably-chat-react-ui-kit SDK in sync with remote
e2b5313 to
c36254f
Compare