diff --git a/developer-docs/README.md b/developer-docs/README.md new file mode 100644 index 000000000..d9426cd19 --- /dev/null +++ b/developer-docs/README.md @@ -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` diff --git a/developer-docs/docs.json b/developer-docs/docs.json new file mode 100644 index 000000000..40466b542 --- /dev/null +++ b/developer-docs/docs.json @@ -0,0 +1,28 @@ +{ + "name": "Chatwoot Developer Docs", + "description": "Official developer documentation for Chatwoot - the open-source customer support platform. Learn about our APIs, integrations, and development guidelines.", + "logo": { + "dark": "/logo/dark.png", + "light": "/logo/light.png" + }, + "favicon": "/favicon.png", + "colors": { + "primary": "#0069ED", + "light": "#4D9CFF", + "dark": "#0050B4" + }, + "theme": "maple", + "navigation": { + "tabs": [ + { + "tab": "API Documentation", + "openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/bde4833e4f866b1fc9dcdbcc14267351406069a3/swagger/swagger.json" + } + ] + }, + "footerSocials": { + "twitter": "https://twitter.com/chatwootapp", + "github": "https://github.com/chatwoot", + "linkedin": "https://www.linkedin.com/company/chatwoot" + } +} diff --git a/developer-docs/favicon.png b/developer-docs/favicon.png new file mode 100644 index 000000000..4b7824e37 Binary files /dev/null and b/developer-docs/favicon.png differ diff --git a/developer-docs/logo/dark.png b/developer-docs/logo/dark.png new file mode 100644 index 000000000..9af20120e Binary files /dev/null and b/developer-docs/logo/dark.png differ diff --git a/developer-docs/logo/light.png b/developer-docs/logo/light.png new file mode 100644 index 000000000..86d75cf5f Binary files /dev/null and b/developer-docs/logo/light.png differ