Skip to content

Commit 2bcb26d

Browse files
Documentation edits made through Mintlify web editor
1 parent 24a42de commit 2bcb26d

File tree

2 files changed

+46
-5
lines changed

2 files changed

+46
-5
lines changed

.github/workflows/ci.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
docs-validation:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: '18'
19+
20+
- name: Install Mintlify
21+
run: npm i -g mintlify
22+
23+
- name: Check broken links
24+
run: mintlify broken-links
25+
26+
- name: Run Vale linting
27+
uses: errata-ai/vale-action@reviewdog
28+
with:
29+
files: .
30+
fail_on_error: true
31+
32+
- name: Validate OpenAPI specs
33+
run: mintlify openapi-check

docs.json

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222
{
2323
"group": "Editing",
2424
"icon": "pen-paintbrush",
25-
"pages": ["development", "web-editor"]
25+
"pages": [
26+
"development",
27+
"web-editor"
28+
]
2629
},
2730
"settings/global",
2831
{
@@ -133,7 +136,10 @@
133136
{
134137
"group": "Dashboard Access",
135138
"icon": "house-lock",
136-
"pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
139+
"pages": [
140+
"advanced/dashboard/sso",
141+
"advanced/dashboard/permissions"
142+
]
137143
},
138144
{
139145
"group": "REST API",
@@ -205,7 +211,7 @@
205211
"pages": [
206212
"integrations/analytics/overview",
207213
"integrations/analytics/amplitude",
208-
"integrations/analytics/clearbit",
214+
"integrations/analytics/clearbit",
209215
"integrations/analytics/fathom",
210216
"integrations/analytics/google-analytics",
211217
"integrations/analytics/google-tag-manager",
@@ -251,7 +257,9 @@
251257
"groups": [
252258
{
253259
"group": "Changelog",
254-
"pages": ["changelog/overview"]
260+
"pages": [
261+
"changelog/overview"
262+
]
255263
}
256264
]
257265
}
@@ -363,4 +371,4 @@
363371
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
364372
}
365373
}
366-
}
374+
}

0 commit comments

Comments
 (0)