feat: Add intro documentation and user guide

.github/workflows/broken-links-check.yml

@@ -1,25 +1,25 @@
 on:
-  schedule:
-    - cron: 0 10 1 * *
-  repository_dispatch:
-    types: [check-link]
-  workflow_dispatch:
+  pull_request:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: pr-${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
 
 name: Broken Link Check
 jobs:
   check:
     name: Broken Link Check
     runs-on: ubuntu-latest
-    timeout-minutes: 10
     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Mint
+        run: npm i -g mint
       - name: Broken Link Check
-        uses: technote-space/broken-link-checker-action@gh-actions
-        with:
-          TARGET: "https://www.chatwoot.com"
-          GITHUB_TOKEN: ${{secrets.ACCESS_TOKEN}}
-
-
-
+        run: |
+          set -o pipefail
+          mint broken-links | tee output.log
+          if ! grep -q "success" output.log; then
+            echo "No success found in log. Exiting."
+            exit 1
+          fi

README.md

@@ -1,29 +1,23 @@
-## Chatwoot Handbook
+## Chatwoot Developer Documentation
 
-This repository contains the documentation for self-hosted installations, features in the product and a complete guide on how we run the organization.
+This is the official repository for the Chatwoot developer documentation. This guide contains everything you need to know about Chatwoot APIs and build custom flows on top of Chatwoot APIs.
 
-----
+### 👩‍💻 Development
 
-## Installation
+Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview the documentation changes locally. To install, use the following command
 
-```console
-pnpm install
 ```
-
-## Local Development
-
-```console
-pnpm start
+npm i -g mint
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-## Build
+Run the following command at the root of your documentation (where mint.json is)
 
-```console
-pnpm build
 ```
+mint dev
+```
+
+### 😎 Publishing Changes
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+Changes will be deployed to production automatically after pushing to the default branch.
 
-Please feel free to suggest any changes. See our [contributing guide](https://www.chatwoot.com/docs/contributing-guide) to get started.
+You can also preview changes using PRs, which generates a preview link of the docs.

api-reference/introduction.mdx

@@ -0,0 +1,49 @@
+---
+title: Introduction to Chatwoot APIs
+description: Learn how to use Chatwoot APIs to build integrations, customize chat experiences, and manage your installation.
+sidebarTitle: Introduction
+---
+
+Welcome to the Chatwoot API documentation. Whether you're building custom workflows for your support team, integrating Chatwoot into your product, or managing users across installations, our APIs provide the flexibility and power to help you do more with Chatwoot.
+
+Chatwoot provides three categories of APIs, each designed with a specific use case in mind:
+
+- **Application APIs** – For account-level automation and agent-facing integrations.
+- **Client APIs** – For building custom chat interfaces for end-users
+- **Platform APIs** – For managing and administering installations at scale
+
+---
+
+## Application APIs
+
+Application APIs are designed for interacting with a Chatwoot account from an agent/admin perspective. Use them to build internal tools, automate workflows, or perform bulk operations like data import/export.
+
+- **Authentication**: Requires a user `access_token`, which can be generated from **Profile Settings** after logging into your Chatwoot account.
+- **Availability**: Supported on both **Cloud** and **Self-hosted** Chatwoot installations.
+- **Example**: [Google Cloud Functions Demo](https://github.com/chatwoot/google-cloud-functions-demo)
+
+---
+
+## Client APIs
+
+Client APIs are intended for building custom messaging experiences over Chatwoot. If you're not using the native website widget or want to embed chat in your mobile app, these APIs are the way to go.
+
+- **Authentication**: Uses `inbox_identifier` (from **Settings → Configuration** in API inboxes) and `contact_identifier` (returned when creating a contact).
+- **Availability**: Supported on both **Cloud** and **Self-hosted** Chatwoot installations.
+- **Examples**:
+
+  - [Client API Demo](https://github.com/chatwoot/client-api-demo)
+  - [Flutter SDK](https://github.com/chatwoot/chatwoot-flutter-sdk)
+
+---
+
+## Platform APIs
+
+Platform APIs are used to manage Chatwoot installations at the admin level. These APIs allow you to control users, roles, and accounts, or sync data from external authentication systems.
+
+- **Authentication**: Requires an `access_token` generated by a **Platform App**, which can be created in the **Super Admin Console**.
+- **Availability**: Available on **Self-hosted** / **Managed Hosting** Chatwoot installations only.
+
+---
+
+Use the right API for your use case, and you'll be able to extend, customize, and integrate Chatwoot into your stack with ease.