docs/.github/workflows/docs.yml at main · TableProApp/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
name: Docs

# No paths filter: this is a required status check, and a filtered workflow never starts on a
# pull request that misses the filter, which leaves the check pending forever.
on:
  pull_request:
  push:
    branches: [main]
  # The app repository does not run these checks, so an app change that contradicts a page is
  # caught here, against the app's main, within a day.
  schedule:
    - cron: '17 6 * * *'
  workflow_dispatch:

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  docs:
    name: Validate docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          path: docs
          persist-credentials: false

      - name: Check out the app
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: TableProApp/TablePro
          ref: main
          path: app
          persist-credentials: false

      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
        with:
          node-version: '22'
          cache: npm
          cache-dependency-path: docs/package-lock.json

      # The CLI self-upgrades inside its own command handlers, so it is pinned in the lockfile.
      - name: Install the Mintlify CLI
        working-directory: docs
        run: npm ci --no-audit --no-fund

      - name: Validate the build
        working-directory: docs
        run: npm run validate

      - name: Check links, anchors and redirects
        working-directory: docs
        run: npm run broken-links

      - name: Check accessibility
        working-directory: docs
        run: npm run a11y

      # The three claims that rot fastest, each checked against the source that
      # defines it. All three were wrong at once in August 2026.
      - name: Check docs against the source
        working-directory: docs
        run: python3 scripts/check-docs-against-source.py --app ../app

      - name: Check writing style
        working-directory: docs
        run: bash scripts/check-writing-style.sh ../app

      # The Mintlify CLI needs a working native toolchain, so it is the step most likely
      # to break on an environment change. This one is plain Python, and it also answers
      # what the CLI does not: a page in no navigation group, which nothing links to, and
      # an app link into this site that no longer resolves.
      - name: Check links, navigation and app links
        working-directory: docs
        run: python3 scripts/check-links.py --app ../app