Skip to content

docs: add bun tab to all install code-groups#452

Merged
brendanjryan merged 1 commit intomainfrom
docs/add-bun-install-tabs
Mar 24, 2026
Merged

docs: add bun tab to all install code-groups#452
brendanjryan merged 1 commit intomainfrom
docs/add-bun-install-tabs

Conversation

@brendanjryan
Copy link
Collaborator

Adds the missing bun tab to install code-groups in card and lightning payment method pages.

Changes

  • card/index.mdx — add bun add mpp-card tab
  • lightning/index.mdx — add bun add @buildonspark/lightning-mpp-sdk tab
  • AGENTS.md — add rule 13: install code-groups must include npm, pnpm, and bun
  • scripts/check-install-tabs.test.ts — vitest lint test that scans all .mdx files and fails if any install code-group is missing a tab

@vercel
Copy link

vercel bot commented Mar 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mpp Ready Ready Preview, Comment Mar 24, 2026 9:50pm

Request Review

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: ecc653c7cc

ℹ️ 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".

for (let i = 0; i < lines.length; i++) {
// Look for a bash [npm] block that contains an install command
const line = lines[i];
if (!/^```bash \[npm\]/.test(line)) continue;

Choose a reason for hiding this comment

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

P2 Badge Detect install groups without an npm tab

checkInstallTabs only validates blocks after matching ````bash [npm], so an install code-group that accidentally omits the npm tab is skipped entirely. In that case the test passes even though the new policy requires all three tabs (npm`, `pnpm`, and `bun`), so this guardrail can miss real violations.

Useful? React with 👍 / 👎.

- Add missing bun tab to card and lightning payment method pages
- Add AGENTS.md rule requiring npm, pnpm, and bun in install code-groups
- Add vitest lint test to enforce the rule across all .mdx files
@brendanjryan brendanjryan force-pushed the docs/add-bun-install-tabs branch from e718e0d to f32c430 Compare March 24, 2026 16:48
@brendanjryan brendanjryan merged commit 85c9196 into main Mar 24, 2026
8 checks passed
@brendanjryan brendanjryan deleted the docs/add-bun-install-tabs branch March 24, 2026 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant