From 2bcb26d784b75b7e4dfad50029479ea8cb3699fb Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 21:01:38 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- .github/workflows/ci.yml | 33 +++++++++++++++++++++++++++++++++ docs.json | 18 +++++++++++++----- 2 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..4269e0d82 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,33 @@ +name: CI + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + docs-validation: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + node-version: '18' + + - name: Install Mintlify + run: npm i -g mintlify + + - name: Check broken links + run: mintlify broken-links + + - name: Run Vale linting + uses: errata-ai/vale-action@reviewdog + with: + files: . + fail_on_error: true + + - name: Validate OpenAPI specs + run: mintlify openapi-check \ No newline at end of file diff --git a/docs.json b/docs.json index 381cdcce0..b4c6930b0 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,10 @@ { "group": "Editing", "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] + "pages": [ + "development", + "web-editor" + ] }, "settings/global", { @@ -133,7 +136,10 @@ { "group": "Dashboard Access", "icon": "house-lock", - "pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"] + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions" + ] }, { "group": "REST API", @@ -205,7 +211,7 @@ "pages": [ "integrations/analytics/overview", "integrations/analytics/amplitude", - "integrations/analytics/clearbit", + "integrations/analytics/clearbit", "integrations/analytics/fathom", "integrations/analytics/google-analytics", "integrations/analytics/google-tag-manager", @@ -251,7 +257,9 @@ "groups": [ { "group": "Changelog", - "pages": ["changelog/overview"] + "pages": [ + "changelog/overview" + ] } ] } @@ -363,4 +371,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file