docs: launch Mintlify docs site with CI and branding refinements#28
docs: launch Mintlify docs site with CI and branding refinements#28ggonzalez94 merged 6 commits intomainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0b9857798a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '22' |
There was a problem hiding this comment.
Docs CI uses unpinned Node 22
Medium Severity
The docs workflow pins actions/setup-node to node-version: '22', but Mintlify’s CLI docs only guarantee Node 20+ (with LTS guidance). If mint@4.2.378 has issues on Node 22, mint validate/broken-links can fail intermittently and block docs-related PRs despite no docs errors.


Summary
docs.json+ structured MDX docs)mint validateandmint broken-linksValidation
npx --yes mint validatenpx --yes mint broken-linksgo test ./...go vet ./...Notes
npx --yes mint dev --no-open --port 3001Note
Low Risk
Docs-only additions plus a new CI workflow; no runtime/production code paths are modified, with the main risk being CI flakiness from docs/link/a11y checks.
Overview
Introduces a dedicated Mintlify docs site under
docs/(newdocs/docs.jsonplus structured.mdxpages for concepts, workflow guides, agent patterns, and CLI/reference contracts).Adds a new
.github/workflows/docs.ymlthat runsmint validate,mint broken-links, andmint a11y(Node 22, pinned Mint CLI version) on docs-related pushes/PRs, and updates.gitignore,README.md,AGENTS.md, andCHANGELOG.mdto document the docs workflow and keep user-facing guidance in sync.Written by Cursor Bugbot for commit f9b4fd0. This will update automatically on new commits. Configure here.