Skip to content

ci(docs): fail PRs on broken Mintlify internal links #1405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HaoChiBao wants to merge 4 commits into
base: main
Choose a base branch
from
Open

ci(docs): fail PRs on broken Mintlify internal links #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e382532
ci(docs): fail PRs on broken Mintlify internal links
HaoChiBao Aug 4, 2026
9cf0085
Merge remote-tracking branch 'origin/main' into fix/docs-broken-links-ci
HaoChiBao Sep 2, 2026
f1af930
ci(docs): isolate mintlify so broken-link CI survives the monorepo
HaoChiBao Sep 2, 2026
c9b829f
fix(docs): point backfill guide at real ingest API pages
HaoChiBao Sep 3, 2026
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
18 changes: 18 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,21 @@ jobs:

- name: Run Biome CI (format & lint on changed files)
run: bunx biome ci --changed --since=origin/main --no-errors-on-unmatched

- name: Detect docs changes
id: docs-changes
run: |
if git diff --quiet "${{ github.event.pull_request.base.sha }}" HEAD -- apps/docs; then
echo "docs=false" >> "$GITHUB_OUTPUT"
else
echo "docs=true" >> "$GITHUB_OUTPUT"
fi

# Isolated bunx avoids the monorepo React/ink hook crash from hoisted mintlify.
# mintlify@4.2.x may exit 0 even when it prints broken links.
- name: Check docs for broken internal links
if: steps.docs-changes.outputs.docs == 'true'
working-directory: apps/docs
run: |
set -o pipefail
bun run check-links 2>&1 | tee /dev/stderr | grep -q "no broken links found"
4 changes: 2 additions & 2 deletions apps/docs/ingestion/batch-ingest-historical-data.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use `POST /v3/documents/batch` to backfill exports, emails, messages, or other d

Backfill dated content by setting `documentDate` on each document, sorting the source records oldest to newest, and sending them in batches. Each request can contain up to 600 documents.

**Endpoint:** [`POST /v3/documents/batch`](/api-reference/ingest/batch-add-documents)
**Endpoint:** [`POST /v3/documents/batch`](/api-reference/ingest)

<CodeGroup>

Expand Down Expand Up @@ -93,7 +93,7 @@ def backfill_historical_data(source_documents: list[dict[str, str]]) -> None:

## Optional: wait for processing to finish

**Endpoint:** [`GET /v3/documents/{id}`](/api-reference/documents/get-document)
**Endpoint:** [`GET /v3/documents/{id}`](/api-reference/ingest)

The batch endpoint returns after accepting the documents. If a later step depends on completed memory generation, poll the returned document IDs until both `status` and `dreamingStatus` are `done`.

Expand Down
3 changes: 2 additions & 1 deletion apps/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"portless": { "name": "docs.dev.supermemory", "script": "dev:app", "appPort": 3003 },
"scripts": {
"dev": "portless",
"dev:app": "bunx mintlify@latest dev --no-open --port 3003"
"dev:app": "bunx mintlify@latest dev --no-open --port 3003",
"check-links": "bunx --bun mintlify@4.2.112 broken-links"
},
"devDependencies": {
"@types/bun": "latest",
Expand Down
Loading