docs: minor update

.github/workflows/broken-links.yml

@@ -0,0 +1,20 @@
+name: Mintlify Broken Links
+on:
+  push:
+
+jobs:
+  broken-links:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+
+      - name: Install Mintlify
+        run: npm i -g mintlify@latest
+
+      - name: Check Broken Links
+        run: mintlify broken-links

README.md

@@ -1,22 +1,41 @@
 <p align="center">
     <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://cachethq.io/assets/cachet-logo-dark.svg">
-      <img alt="Cachet Logo" src="https://cachethq.io/assets/cachet-logo-light.svg">
+      <source media="(prefers-color-scheme: dark)" srcset="https://cachethq.io/assets/cachet-logo-dark.svg" />
+      <img alt="Cachet Logo" src="https://cachethq.io/assets/cachet-logo-light.svg" />
     </picture>
 </p>
 
-## Introduction
+<p align="center">
+    <a href="https://github.com/sponsors/cachethq">
+        <img src="https://img.shields.io/github/sponsors/cachethq" alt="GitHub Sponsors" />
+    </a>
+</p>
 
-This repository contains the documentation for Cachet and is deployed to https://docs.cachethq.io/.
+# Cachet Documentation
 
-## Contributing to the documentation
+[Cachet](https://cachethq.io) is an easy-to-use and powerful open-source status page system. Cachet allows you effectively communicate downtime and
+system outages to your customers, teams, and shareholders.
 
-Please refer to our description on [CONTRIBUTING.md](https://github.com/cachethq/docs/blob/main/.github/CONTRIBUTING.md) for details on how to contribute to this project.
+This repository contains the source code for the Cachet documentation which is built using [Mintlify](https://mintlify.com).
 
-## Security Vulnerabilities
+## Running Locally
 
-Please review our [security policy](https://github.com/cachethq/cachet/security/policy) on how to report security vulnerabilities.
+The documentation is kindly hosted by [Mintlify](https://mintlify.com). To run the documentation locally:
 
-## License
+1. **Clone the repository:**
+    ```bash
+    git clone git@github.com:cachethq/docs.git cachet-docs
+    ```
+2. **Install Mintlify:**
+    ```bash
+    npm install -g mintlify@latest
+    ```
+3. **Run the documentation:**
+    ```bash
+    cd cachet-docs
+    mintlify dev
+    ```
+
+## Contributing
 
-Cachet Docs is open-sourced software licensed under the [MIT license](LICENSE.md).
+Check out the [Mintlify Guide](https://mintlify.com/docs/) to learn more.

api-reference/authentication.mdx

@@ -0,0 +1,20 @@
+---
+title: 'Authentication'
+description: 'Learn how to authenticate with the Cachet API'
+---
+
+<Tip>
+    Cachet is built on the belief that your service status is open and transparent, therefore all `GET` requests are public and require no authentication to access the information.
+</Tip>
+
+Authenticated requests (those that `POST`, `PUT` or `DELETE`) require an **API Token**.
+
+### API Token
+
+API Tokens are the preferred method of authentication. 
+
+Once you have your token you'll need to add a new request header of `Authorization: Bearer $TOKEN`:
+
+```shell
+curl -H "Content-Type: application/json;" -H "Authorization: Bear YOUR_KEY_HERE" -d '{"name":"API","description":"An example description","status":1}' https://v3.cachethq.io/api/components
+```

api-reference/filtering.mdx

@@ -0,0 +1,34 @@
+---
+title: 'Filtering & Sorting'
+description: 'Learn how to filter and sort data in the Cachet API.'
+---
+
+## Filtering
+
+Several endpoints support filtering to allow you to retrieve only the data you need.  For example, you can filter incidents by status:
+
+```
+GET /api/incidents?filter[status]=1
+```
+
+<Note>
+Each endpoint may support different fields for filtering. Check the documentation for the specific endpoint you are working with.
+</Note>
+
+## Sorting
+
+You can sort the results of an endpoint by passing the `sort` parameter. The `sort` parameter should be a comma-separated list of fields to sort by. You can also specify the sort order by appending `asc` or `desc` to the field name.
+
+```
+GET /api/incidents?sort=id
+```
+
+To reverse the sort order, you can prefix the field name with a hyphen.
+
+```
+GET /api/incidents?sort=-id
+```
+
+<Note>
+    Each endpoint may support different fields for sorting. Check the documentation for the specific endpoint you are working with.
+</Note>