Official documentation for Celo, built with Mintlify.
We have automated checks for errors and broken links that run on every push and pull request.
Before committing, run local validation:
# Run all validation checks
./scripts/validate-docs.sh
# Check for broken links using Mintlify CLI
mint broken-links- ✅ Broken Links Check - Automatically scans for broken internal/external links
- ✅ Structure Validation - Validates docs.json syntax and structure
- ✅ MDX File Verification - Ensures all referenced files exist
- ✅ Syntax Checking - Detects common MDX/JSX syntax errors
- ✅ PR Comments - Automatically comments on PRs with validation results
Run ./scripts/validate-docs.sh to check for errors before committing.
Install the Mintlify CLI to preview your documentation changes locally:
npm i -g mintRun the following command at the root of your documentation, where your docs.json is located:
mint devView your local preview at http://localhost:3000.
Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
Important: All PRs must pass validation checks before merging.
-
Before committing:
- Run
./scripts/validate-docs.shto check for errors - Test your changes locally with
mint dev - Ensure all links work correctly
- Run
-
Creating a PR:
- Wait for automated checks to complete
- Review any validation warnings or errors
- Fix issues before requesting review
-
For reviewers:
- Check that all validation checks pass
- Review any warnings in PR comments
- Verify changes render correctly
- Dev environment not running: Run
mint updateto ensure you have the most recent version of the CLI - Page loads as 404: Make sure you are running in a folder with a valid
docs.json - Validation fails: Run
./scripts/validate-docs.shand review the output for specific errors - Broken links detected: Review the validation output and fix referenced files or URLs