Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
29 changes: 5 additions & 24 deletions .github/workflows/docs-validation.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,24 @@
name: Documentation Validation

on:
push:
branches:
- main
- master
pull_request:
branches:
- main
- master
workflow_dispatch:

jobs:
validate-docs:
name: Check for Errors and Broken Links
name: Check for broken links
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v5
with:
fetch-depth: 0

- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: '22'

- name: Install jq
run: sudo apt-get update && sudo apt-get install -y jq
node-version: "24"

- name: Run validation script
id: validate
run: |
echo "## 📚 Documentation Validation" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Running validation checks using ./scripts/validate-docs.sh" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY

# Make script executable and run it
chmod +x ./scripts/validate-docs.sh
./scripts/validate-docs.sh
- name: Check for broken links
run: npx mintlify broken-links
44 changes: 0 additions & 44 deletions .github/workflows/mintlify-ci.yml

This file was deleted.

52 changes: 6 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,26 @@
# Celo Documentation

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

## 🔍 Documentation Validation

We have automated checks for errors and broken links that run on every push and pull request.

### Quick Validation

Before committing, run local validation:

```bash
# Run all validation checks
./scripts/validate-docs.sh

# Check for broken links using Mintlify CLI
mint broken-links
```

### CI/CD Workflows

- ✅ **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.

## Development
## Making Changes

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

```sh
npm i -g mint
```

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

```bash
```sh
mint dev
```

View your local preview at `http://localhost:3000`.

## Publishing changes

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.

**Important:** All PRs must pass validation checks before merging.

## Contributing

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

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

## Need help?

### Troubleshooting

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

- [Celo Documentation](https://docs.celo.org)
- [Validation Script](./scripts/validate-docs.sh)
- [Mintlify Documentation](https://mintlify.com/docs)
- [Mintlify Community](https://mintlify.com/community)
- [Celo Discord](https://discord.com/invite/celo)
- [Mintlify documentation](https://mintlify.com/docs)
- [Mintlify community](https://mintlify.com/community)
- [Mintlify Documentation](https://mintlify.com/docs)
157 changes: 0 additions & 157 deletions scripts/validate-docs.sh

This file was deleted.