Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
40 changes: 40 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Docs CI

on:
pull_request:
branches: [main]

jobs:
validate:
name: Validate docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: "20"

- name: Check broken links
run: npx mintlify@latest broken-links

- name: Grammar lint (Vale)
uses: errata-ai/vale-action@v2
with:
reporter: github-pr-check
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Validate frontmatter
run: |
missing=()
for file in $(find . -name '*.mdx' -not -path './node_modules/*'); do
head -20 "$file" | grep -q '^title:' || missing+=("$file (missing title)")
head -20 "$file" | grep -q '^description:' || missing+=("$file (missing description)")
done
if [ ${#missing[@]} -gt 0 ]; then
echo "Files with missing frontmatter:"
printf ' %s\n' "${missing[@]}"
exit 1
fi
echo "All MDX files have required frontmatter."
8 changes: 8 additions & 0 deletions .mintlify/workflows/broken-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Check Broken Links
on:
cron: "0 9 * * 1"
---

Check all internal links in the documentation for broken references.
Fix any broken links by updating paths to match current file structure.
13 changes: 13 additions & 0 deletions .mintlify/workflows/sdk-docs-sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Update SDK Documentation
on:
push:
- repo: BackTrackCo/x402r-sdk
branch: main
---

Review the diff from the latest push to BackTrackCo/x402r-sdk.
Identify changed function signatures, new exports, or removed functions.
Update the relevant SDK documentation pages under sdk/.
Only modify SDK pages. Do not touch protocol or contract documentation.
Follow the writing style in CLAUDE.md.
7 changes: 7 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[*]
BasedOnStyles = Vale, x402r

MinAlertLevel = warning

[*.mdx]
BasedOnStyles = Vale, x402r
7 changes: 6 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,12 @@
"href": "https://github.com/BackTrackCo"
}
},
"feedback": {
"thumbsRating": true
},
"search": {
"prompt": "Search x402r docs..."
},
"contextual": {
"options": [
"copy",
Expand All @@ -172,7 +178,6 @@
"vscode"
]
},
"redirects": [],
"footer": {
"socials": {
"x": "https://x.com/x402rorg",
Expand Down
10 changes: 10 additions & 0 deletions styles/x402r/AllowsYouTo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: "Rewrite without 'allows you to' — state what it does directly."
level: warning
ignorecase: true
tokens:
- allows you to
- enabling you to
- enables you to
- makes it easy to
- gives you the ability to
10 changes: 10 additions & 0 deletions styles/x402r/Enthusiasm.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: "Avoid enthusiasm markers: '%s'"
level: warning
ignorecase: true
tokens:
- Amazing
- Exciting
- Great news
- Incredibly
- Super easy
20 changes: 20 additions & 0 deletions styles/x402r/Slop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
extends: existence
message: "Avoid filler/marketing language: '%s'"
level: warning
ignorecase: true
tokens:
- seamless
- robust
- comprehensive
- empower
- revolutionize
- unlock the
- leverage
- easy to use
- easy-to-use
- cutting-edge
- game-changer
- next-generation
- world-class
- best-in-class
- state-of-the-art
Loading