add Open API v3 developer docs

2025-05-08 12:47:22 +07:00
parent bfddc4da24
commit f4a77dabd9
5 changed files with 56 additions and 0 deletions
@@ -0,0 +1,28 @@
+## Chatwoot Developer Documentation
+
+Welcome to the official Chatwoot developer documentation. This guide contains everything you need to know about Chatwoot APIs and build custom flows on top of Chatwoot APIs.
+
+### 👩‍💻 Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+
+```
+npm i -g mintlify
+```
+
+Run the following command at the root of your documentation (where mint.json is)
+
+```
+mintlify dev
+```
+
+### 😎 Publishing Changes
+
+Changes will be deployed to production automatically after pushing to the default branch.
+
+You can also preview changes using PRs, which generates a preview link of the docs.
+
+#### Troubleshooting
+
+- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
+- Page loads as a 404 - Make sure you are running in a folder with `mint.json`