ci: add GitHub workflows for documentation validation and Mintlify checks #2047
+409
−120
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
viral-sangani
commented
Sep 30, 2025
viral-sangani
commented
- Broken Links Fixed (92 total)
- Script Improvements
- Added CICD to check valid docs
📚 Documentation Validation ResultsCheck Status
This check was performed by the Documentation Validation workflow. |
📚 Documentation Validation ResultsCheck Status
Broken Links DetailsThis check was performed by the Documentation Validation workflow. |
📚 Documentation Validation ResultsCheck Status
Broken Links DetailsThis check was performed by the Documentation Validation workflow. |
palango
reviewed
Sep 30, 2025
viral-sangani
requested review from
palango and
piersy
and removed request for
a team
- Add set +e/set -e wrapper around mint broken-links command - Capture exit code to prevent script from exiting early - Allow script to continue and report all validation errors - Fixes workflow failure when broken links are detected
- Fix stablecoin links in build-with-defi.mdx (use absolute paths) - Fix plumo verification link to use relative path - Replace broken /glossary#epoch-rewards links with actual epoch rewards pages - Replace broken /glossary#slashing links with actual penalties pages - All 7 broken links across 6 files now resolved Verified with: mint broken-links
piersy
reviewed
Oct 27, 2025
Comment on lines
+92
to
+113
| echo "3️⃣ Checking for missing MDX files..." | ||
| if [ "$JQ_AVAILABLE" = true ]; then | ||
| MISSING_FILES=0 | ||
|
|
||
| # Extract all page references and check if files exist | ||
| jq -r '.. | .pages? // empty | .[] | select(type == "string")' docs.json 2>/dev/null | while read -r page; do | ||
| file_path="${page}.mdx" | ||
|
|
||
| if [ ! -f "$file_path" ] && [ ! -f "${page}.md" ]; then | ||
| echo -e "${YELLOW}⚠️ Missing file: $file_path${NC}" | ||
| MISSING_FILES=$((MISSING_FILES + 1)) | ||
| fi | ||
| done | ||
|
|
||
| if [ $MISSING_FILES -eq 0 ]; then | ||
| echo -e "${GREEN}✅ All referenced MDX files exist${NC}" | ||
| else | ||
| echo -e "${YELLOW}⚠️ Some referenced files are missing${NC}" | ||
| fi | ||
| else | ||
| echo -e "${YELLOW}⚠️ Skipping MDX file check (jq not available)${NC}" | ||
| fi |
Contributor
There was a problem hiding this comment.
Shellcheck errors for this.
In scripts/validate-docs.sh line 102:
MISSING_FILES=$((MISSING_FILES + 1))
^-----------^ SC2030 (info): Modification of MISSING_FILES is local (to subshell caused by pipeline).
In scripts/validate-docs.sh line 106:
if [ $MISSING_FILES -eq 0 ]; then
^------------^ SC2031 (info): MISSING_FILES was modified in a subshell. That change might be lost.
Basically piping input to the loop results in all variable changes inside the loop being local to the loop, so MISSING_FILES will always be 0 when checked after the loop.
You can fix this by using process substitution to feed input to the loop:
...
done < <(jq -r '.. | .pages? // empty | .[] | select(type == "string")' docs.json 2>/dev/null
piersy
reviewed
Oct 27, 2025
| - name: Run Mintlify validation | ||
| run: | | ||
| echo "Running Mintlify validation checks..." | ||
| mint install || true |
Contributor
There was a problem hiding this comment.
It would be good to document why you are allowing errors in mint install
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.