DOCUMENTATION.md

Documenting the SDK

If you are introducing changes impacting the API or behavior of the SDK parts, you should document these. Our documentation is generated with docusaurus. We have our own cli tool stream-chat-docusaurus-cli to run the documentation server locally, so that you can inspect your adjustments.

Run the documentation server locally

1. Install stream-chat-docusaurus-cli (You will need it to serve the documentation locally)
2. Run the documentation server

yarn docs-run

Documentation patterns

To keep the documentation consistent we would like you to adhere to the following recommendations:

1. todo