Skip to content

feat(docs): add Mintlify documentation site and auto-sync pipeline - #58

Merged
farizanjum merged 13 commits into
mainfrom
feat/mintlify-docs
Oct 17, 2026
Merged

farizanjum merged 13 commits into
mainfrom
feat/mintlify-docs

Conversation

@farizanjum

@farizanjum farizanjum commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds the Mintlify documentation setup inside docs/ and a build script (scripts/build-mintlify-docs.ts) that compiles all skill README.md files and CONTRIBUTING.md into sanitized Mintlify .mdx pages with interactive install blocks.

What Changed

  • Added scripts/build-mintlify-docs.ts and pnpm run build:docs in package.json (plus lint-staged and CI validation integration) to convert every skill's README.md into docs/skills//.mdx and update docs/docs.json navigation automatically.
  • Added core Mintlify documentation pages (docs/introduction.mdx, docs/installation.mdx, docs/contributing.mdx, docs/cli/overview.mdx, docs/cli/compatibility.mdx, docs/skills/overview.mdx).
  • Generated all 65 skill .mdx pages, copied local skill assets into docs/assets/skills/, and generated docs/docs.json.

Verification

  • Ran pnpm exec tsx scripts/build-mintlify-docs.ts
  • Verified all generated .mdx files contain valid YAML frontmatter and zero unescaped HTML comments or JSX syntax errors.

RetriggerView in GreptileConfidence Score: 5/5

Safe to merge based on the reviewed changes; no outstanding blocking findings.

Summary

Adds a Mintlify documentation site and keeps generated pages aligned with the skill catalog.

  • Readers can find setup, CLI, compatibility, and contribution guides in one place.
  • Readers can browse skill guides grouped into a linked catalog.
  • A docs builder turns skill sources into Mintlify pages and keeps them in sync.
  • The CLI places openverse-sfx in the Video & Graphics group.

Reviews (6) · Last reviewed commit: "chore: remove .mcp.json from repository" · Reviewed by Greptile

Copilot AI balanced review requested due to automatic review settings October 17, 2026 06:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

Comment thread scripts/build-mintlify-docs.ts Outdated
Comment thread docs/installation.mdx Outdated
Comment thread package.json Outdated
Comment thread package.json Outdated
@mintlify

mintlify Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
varnan 🟢 Ready View Preview Oct 17, 2026, 8:45 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread docs/cli/overview.mdx Outdated
Comment thread scripts/build-mintlify-docs.ts Outdated
@farizanjum
farizanjum merged commit 1785c7c into main Oct 17, 2026
3 checks passed
@farizanjum
farizanjum deleted the feat/mintlify-docs branch October 17, 2026 09:09
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.

2 participants