Skip to content

docs: launch Mintlify docs site with CI and branding refinements#28

Merged
ggonzalez94 merged 6 commits intomainfrom
docs
Feb 24, 2026
Merged

docs: launch Mintlify docs site with CI and branding refinements#28
ggonzalez94 merged 6 commits intomainfrom
docs

Conversation

@ggonzalez94
Copy link
Owner

@ggonzalez94 ggonzalez94 commented Feb 24, 2026

Summary

  • add a dedicated Mintlify docs site (docs.json + structured MDX docs)
  • add docs CI workflow running mint validate and mint broken-links
  • refine public docs IA (remove overlapping cookbook/ops content)
  • clarify provider-driven API key requirements across docs
  • add branded lobster header logo assets for Mintlify
  • align README, AGENTS, and CHANGELOG with docs workflow expectations

Validation

  • npx --yes mint validate
  • npx --yes mint broken-links
  • go test ./...
  • go vet ./...

Notes

  • Docs preview can be started locally with: npx --yes mint dev --no-open --port 3001

Note

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/ (new docs/docs.json plus structured .mdx pages for concepts, workflow guides, agent patterns, and CLI/reference contracts).

Adds a new .github/workflows/docs.yml that runs mint validate, mint broken-links, and mint a11y (Node 22, pinned Mint CLI version) on docs-related pushes/PRs, and updates .gitignore, README.md, AGENTS.md, and CHANGELOG.md to 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.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

@ggonzalez94 ggonzalez94 merged commit 57740df into main Feb 24, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant