Skip to content

Commit 72769df

Browse files
committed
ci: Cleanup validation
1 parent 9cb99b6 commit 72769df

4 files changed

Lines changed: 11 additions & 271 deletions

File tree

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,24 @@
11
name: Documentation Validation
22

33
on:
4-
push:
5-
branches:
6-
- main
7-
- master
84
pull_request:
95
branches:
106
- main
11-
- master
127
workflow_dispatch:
138

149
jobs:
1510
validate-docs:
16-
name: Check for Errors and Broken Links
11+
name: Check for broken links
1712
runs-on: ubuntu-latest
18-
13+
1914
steps:
2015
- name: Checkout repository
2116
uses: actions/checkout@v5
22-
with:
23-
fetch-depth: 0
2417

2518
- name: Setup Node.js
2619
uses: actions/setup-node@v6
2720
with:
28-
node-version: '22'
29-
30-
- name: Install jq
31-
run: sudo apt-get update && sudo apt-get install -y jq
21+
node-version: "24"
3222

33-
- name: Run validation script
34-
id: validate
35-
run: |
36-
echo "## 📚 Documentation Validation" >> $GITHUB_STEP_SUMMARY
37-
echo "" >> $GITHUB_STEP_SUMMARY
38-
echo "Running validation checks using ./scripts/validate-docs.sh" >> $GITHUB_STEP_SUMMARY
39-
echo "" >> $GITHUB_STEP_SUMMARY
40-
41-
# Make script executable and run it
42-
chmod +x ./scripts/validate-docs.sh
43-
./scripts/validate-docs.sh
23+
- name: Check for broken links
24+
run: npx mintlify broken-links

.github/workflows/mintlify-ci.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,26 @@
11
# Celo Documentation
22

3-
Official documentation for Celo, built with [Mintlify](https://mintlify.com).
3+
Official documentation for Celo
44

5-
## 🔍 Documentation Validation
6-
7-
We have automated checks for errors and broken links that run on every push and pull request.
8-
9-
### Quick Validation
10-
11-
Before committing, run local validation:
12-
13-
```bash
14-
# Run all validation checks
15-
./scripts/validate-docs.sh
16-
17-
# Check for broken links using Mintlify CLI
18-
mint broken-links
19-
```
20-
21-
### CI/CD Workflows
22-
23-
-**Broken Links Check** - Automatically scans for broken internal/external links
24-
-**Structure Validation** - Validates docs.json syntax and structure
25-
-**MDX File Verification** - Ensures all referenced files exist
26-
-**Syntax Checking** - Detects common MDX/JSX syntax errors
27-
-**PR Comments** - Automatically comments on PRs with validation results
28-
29-
Run `./scripts/validate-docs.sh` to check for errors before committing.
30-
31-
## Development
5+
## Making Changes
326

337
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally:
348

359
```sh
3610
npm i -g mint
3711
```
3812

39-
Run the following command at the root of your documentation, where your `docs.json` is located:
13+
Run the following command. It will display a preview of you changes at `http://localhost:3000`.
4014

41-
```bash
15+
```sh
4216
mint dev
4317
```
4418

45-
View your local preview at `http://localhost:3000`.
46-
47-
## Publishing changes
48-
49-
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
50-
51-
**Important:** All PRs must pass validation checks before merging.
52-
5319
## Contributing
5420

5521
1. **Before committing:**
56-
- Run `./scripts/validate-docs.sh` to check for errors
5722
- Test your changes locally with `mint dev`
23+
- Check for broken links with `mint broken-links`
5824
- Ensure all links work correctly
5925

6026
2. **Creating a PR:**
@@ -67,8 +33,6 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
6733
- Review any warnings in PR comments
6834
- Verify changes render correctly
6935

70-
## Need help?
71-
7236
### Troubleshooting
7337

7438
- **Dev environment not running:** Run `mint update` to ensure you have the most recent version of the CLI
@@ -79,9 +43,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
7943
### Resources
8044

8145
- [Celo Documentation](https://docs.celo.org)
82-
- [Validation Script](./scripts/validate-docs.sh)
83-
- [Mintlify Documentation](https://mintlify.com/docs)
84-
- [Mintlify Community](https://mintlify.com/community)
8546
- [Celo Discord](https://discord.com/invite/celo)
86-
- [Mintlify documentation](https://mintlify.com/docs)
87-
- [Mintlify community](https://mintlify.com/community)
47+
- [Mintlify Documentation](https://mintlify.com/docs)

scripts/validate-docs.sh

Lines changed: 0 additions & 157 deletions
This file was deleted.

0 commit comments

Comments
 (0)