Skip to content

Add docs infrastructure: CI, feedback, Mintlify workflows#16

Merged
vraspar merged 3 commits into
mainfrom
vraspar/docs-infra
Mar 20, 2026
Merged

Add docs infrastructure: CI, feedback, Mintlify workflows#16
vraspar merged 3 commits into
mainfrom
vraspar/docs-infra

Conversation

@vraspar
Copy link
Copy Markdown
Contributor

@vraspar vraspar commented Mar 20, 2026

Summary

  • Add feedback.thumbsRating and search.prompt to docs.json, remove empty redirects: []
  • Add GitHub Actions CI workflow: mintlify broken-links check + frontmatter validation (title/description) on every PR — free-plan alternative to Mintlify Pro CI checks
  • Add Mintlify Workflow sdk-docs-sync.md — auto-updates SDK docs when BackTrackCo/x402r-sdk main changes (requires Mintlify Workflows beta + GitHub App on SDK repo)
  • Add Mintlify Workflow broken-links.md — weekly broken link scan

Manual steps (Mintlify dashboard)

After merge:

  1. Enable Analytics — Analytics section in dashboard (available on free plan)
  2. Mintlify Workflows — requires GitHub App connected to x402r-sdk via Mintlify dashboard. If dashboard does not support adding a second repo on free plan, workflows are ready for when it does.

Note: Preview Deployments, CI/CD checks, and PostHog are Pro-only. Our GitHub Actions CI covers broken links + frontmatter validation as a free-plan alternative.

Test plan

  • Verify docs.json is valid JSON and Mintlify preview renders correctly
  • Confirm CI workflow triggers on PR and broken-links check passes
  • Confirm .mintlify/workflows/ files are present for future use

vraspar and others added 2 commits March 20, 2026 01:26
- Add feedback thumbsRating and search prompt to docs.json
- Remove empty redirects array
- Add GitHub Actions CI: broken-links check + frontmatter validation on PRs
- Add Mintlify Workflow to auto-update SDK docs on x402r-sdk push
- Add Mintlify Workflow for weekly broken link scan

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add Vale action to CI workflow (free alternative to Mintlify Pro grammar linter)
- Custom x402r style rules: catch filler/marketing language, "allows you to" patterns, enthusiasm markers
- Reports inline on PRs via github-pr-check

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@A1igator A1igator self-requested a review March 20, 2026 08:48
A1igator
A1igator previously approved these changes Mar 20, 2026
- Add Microsoft, write-good, proselint packages (battle-tested, maintained)
- Downgrade noisy Microsoft rules (contractions OFF, sentence length + passive to suggestion)
- Keep custom x402r style for project-specific anti-slop rules
- Scope Vale to .mdx files only

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vraspar vraspar merged commit 0f3bb83 into main Mar 20, 2026
2 checks passed
@vraspar vraspar deleted the vraspar/docs-infra branch March 20, 2026 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants