Repository navigation
feat(ci): add website + docs CI workflows for merged docs source - #42
Merged
Merged
Conversation
The Mintlify docs source merged in 6d1004a had no CI coverage and the website itself had no CI gates. This adds two scoped workflows (website: lint/format:check/build; docs: prettier/markdownlint/mintlify broken-links) plus the tooling to support them, and documents the new boundary in AGENTS.md. - .github/workflows/website.yml — paths-ignore docs/**; pnpm@10/node@24; permissions: contents: read. - .github/workflows/docs.yml — paths docs/** + tool-config + lockfile so devDep bumps re-run; pinned mintlify@4.2.555. - .markdownlint-cli2.jsonc — MDX-friendly (MD013/033/034/041 disabled); markdownlint-cli2 added as devDep. - ESLint globalIgnores docs/**; lint-staged glob now covers .mdx. - AGENTS.md — Layout entry + Gotcha explaining the docs surface is a separate Mintlify build, not part of pnpm build. - Drive-bys: gitignore .claude/settings.local.json (untracked local drift was breaking format:check); reformat the 10 merged MDX files with Prettier; add 'text' language to one fenced block (MD040). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Deploying website with
|
| Latest commit: |
fac56d6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://29e0f1de.website-70y.pages.dev |
| Branch Preview URL: | https://feat-docs-ci.website-70y.pages.dev |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces documentation linting using markdownlint-cli2 and updates the project's documentation structure. Key changes include the addition of a .markdownlint-cli2.jsonc configuration file, updates to .gitignore and .prettierignore to exclude local Claude settings, and new documentation in AGENTS.md regarding the docs/ directory's independent build pipeline. Several MDX files were also reformatted for consistency. Feedback suggests integrating the new markdown linter into the lint-staged configuration in package.json to ensure documentation is automatically linted and fixed before being committed.
There was a problem hiding this comment.
Pull request overview
Adds CI separation between the Next.js marketing website and the Mintlify docs/ source, introducing dedicated workflows and docs-specific linting while updating repo tooling/config to reflect the new boundary.
Changes:
- Add separate GitHub Actions workflows for
website(lint/format/build) anddocs(Prettier, markdownlint-cli2, Mintlify broken-links). - Introduce
markdownlint-cli2with an MDX-friendly config, and update tooling to treatdocs/as a separate product (ESLint ignore + AGENTS guidance). - Apply Prettier reformatting to merged MDX docs and tighten formatting behavior (e.g., fenced code block language).
Reviewed changes
Copilot reviewed 17 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Locks markdownlint-cli2 and its dependency graph for consistent CI installs. |
| package.json | Adds markdownlint-cli2 devDep and includes mdx in lint-staged Prettier globs. |
| eslint.config.mjs | Ignores docs/** so website linting doesn’t traverse Mintlify sources. |
| docs/protocol/takedown.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/protocol/slashing.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/protocol/reputation.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/protocol/privacy.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/protocol/governance.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/protocol/content-addressing.mdx | Adds fenced block language (text) and reformats a table. |
| docs/overview/participants.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/overview/how-it-works.mdx | Prettier reformat of tables for consistent MDX rendering. |
| docs/overview/glossary.mdx | Prettier reformat of glossary table for consistent MDX rendering. |
| docs/overview/architecture.mdx | Prettier reformat of participant roles table for consistent MDX rendering. |
| AGENTS.md | Documents that docs/ is built/served independently from the website export. |
| .prettierignore | Ignores local Claude state file to prevent format:check failures. |
| .markdownlint-cli2.jsonc | Adds MDX-friendly markdownlint-cli2 configuration scoped to docs/**. |
| .gitignore | Ignores local Claude state file from version control. |
| .github/workflows/website.yml | Adds website CI workflow (lint, format:check, build) with path filtering. |
| .github/workflows/docs.yml | Adds docs CI workflow (Prettier, markdownlint-cli2, Mintlify broken-links) with path filtering. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- website.yml: drop `**/*.md` from paths-ignore so root-MD-only PRs
(AGENTS.md, README.md, CLAUDE.md) still run `pnpm format:check`.
- docs.yml: add `.prettierrc.json` and `.prettierignore` to both
triggers so changes to Prettier config re-run the docs check.
- package.json: add `markdownlint-cli2 --fix` to the lint-staged glob
for `docs/**/*.{md,mdx}`, matching the CI scope so commit-time
enforcement mirrors what CI catches.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Summary
.github/workflows/website.yml(lint / format:check / build,paths-ignore: docs/**) and.github/workflows/docs.yml(Prettier +markdownlint-cli2+mintlify broken-links). Both pinpnpm@10/node@24and dropGITHUB_TOKENtocontents: read..markdownlint-cli2.jsonc(MDX-friendly: MD013/033/034/041 disabled) andmarkdownlint-cli2as a devDep. Excludedocs/**from ESLint; include.mdxin the lint-staged glob.AGENTS.md—docs/is a Mintlify-built product served fromdocs.decdn.org, independent ofpnpm build.textlanguage to one fenced block (MD040 fix indocs/protocol/content-addressing.mdx)..claude/settings.local.json— untracked local state was breakingpnpm format:check.Flagged (not in this PR)
lib/links.tsrunNodepoints athttps://docs.decdn.org/node-operators/overview, but the mergeddocs/has nonode-operators/section yet — once Mintlify rebuilds it will 404 until that section is authored. Out of scope here.Test plan
pnpm lintpnpm format:checkpnpm buildpnpm exec markdownlint-cli2— 14 files, 0 errors(cd docs && npx -y mintlify@4.2.555 broken-links)— "no broken links found"websiteworkflow runs (and only it) when this PR's non-docs files changedocsworkflow runs (and only it) on a follow-up MDX-only change🤖 Generated with Claude Code