Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"version": "0.2",
"language": "en,en-GB",
"ignorePaths": [
"node_modules/**",
".github/**",
"images/**",
"logo/**",
"favicon.*",
"docs.json",
".cspell.json"
],
"ignoreRegExpList": [
"https?://[^\\s)\\]'\"]+",
"`[^`]+`",
"\\$\\{[^}]+\\}"
],
"words": [
"Airtable",
"Anthropic",
"Apaleo",
"Asana",
"Atlassian",
"Attio",
"Authorize",
"Canva",
"CCPA",
"BYO",
"Cloudflare",
"Cloudflared",
"Composio",
"Customization",
"DCR",
"Disconnect",
"Discord",
"Dropbox",
"fintech",
"Fluso",
"Fumadocs",
"Github",
"GitLab",
"Hubspot",
"Intercom",
"Linear",
"MDX",
"Microsoft",
"Mintlify",
"Notion",
"OAuth",
"OneDrive",
"PayPal",
"PKCE",
"Premai",
"Reauth",
"Reauthorize",
"Reconnect",
"Roobert",
"Salesforce",
"SaaS",
"Sentry",
"Skydo",
"Slack",
"SSRF",
"Standups",
"Tetris",
"Tunguz",
"Webflow",
"Wix",
"Xero",
"frontmatter",
"reauth",
"reauthorize",
"uvx",
"webhook"
]
}
42 changes: 42 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: deploy to Mintlify

on:
push:
branches: [main]
workflow_dispatch:

concurrency:
group: mintlify-deploy
cancel-in-progress: false

jobs:
deploy:
name: Trigger Mintlify redeploy
runs-on: ubuntu-latest
steps:
- name: Check secrets are configured
env:
MINTLIFY_API_KEY: ${{ secrets.MINTLIFY_API_KEY }}
MINTLIFY_PROJECT_ID: ${{ secrets.MINTLIFY_PROJECT_ID }}
run: |
if [ -z "$MINTLIFY_API_KEY" ] || [ -z "$MINTLIFY_PROJECT_ID" ]; then
echo "::error::MINTLIFY_API_KEY and MINTLIFY_PROJECT_ID must be set as repo secrets."
exit 1
fi

- name: Trigger redeploy
env:
MINTLIFY_API_KEY: ${{ secrets.MINTLIFY_API_KEY }}
MINTLIFY_PROJECT_ID: ${{ secrets.MINTLIFY_PROJECT_ID }}
run: |
response=$(curl -sS -w '\n%{http_code}' \
-X POST "https://api.mintlify.com/v1/project/update/${MINTLIFY_PROJECT_ID}" \
-H "Authorization: Bearer ${MINTLIFY_API_KEY}")
body=$(echo "$response" | head -n -1)
code=$(echo "$response" | tail -n 1)
echo "HTTP $code"
echo "$body"
if [ "$code" -lt 200 ] || [ "$code" -ge 300 ]; then
echo "::error::Mintlify redeploy failed (HTTP $code)"
exit 1
fi
40 changes: 40 additions & 0 deletions .github/workflows/docs-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: docs checks

on:
pull_request:
branches: [main]

jobs:
mint-check:
name: Mintlify build + broken links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 22

- name: Install Mintlify CLI
run: npm install -g mint

- name: Check broken links and MDX parse
# mint won't start if docs.json is malformed or any .mdx fails to parse,
# so this single command also covers schema + parse validation.
run: mint broken-links

spell-check:
name: Spell check (cspell)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 22

- name: Install cspell
run: npm install -g cspell

- name: Run cspell on docs
run: cspell "**/*.mdx" --no-progress --no-summary --show-context
Loading