Skip to content

docs: settle the bestax-migrate bundling call, create-bestax ships it - #512

Merged
allxsmith merged 3 commits into
mainfrom
docs/385-bundle-bestax-migrate
Aug 13, 2026
Merged

allxsmith merged 3 commits into
mainfrom
docs/385-bundle-bestax-migrate

Conversation

@allxsmith

@allxsmith allxsmith commented Aug 13, 2026 •

Copy link
Copy Markdown
Owner

What

Aligns the last docs with the call made in #385: the bestax-migrate skill is part of the create-bestax bundle. Four files, prose only:

Why

The code has shipped the skill since #345 (sync-skills.mjs allowlist, the scaffolded CLAUDE_MD roster, setupSkills()), while two docs pages still said it was deliberately not bundled. #385 asked for a direction decision; the decision is recorded on the issue: one uniform bundle, no per-skill carve-out to keep in sync, and the skill costs a fresh scaffold nothing.

Not in this PR

  • No behavior changes: sync-skills.mjs and setupSkills() are untouched.
  • pnpm gen produced no diff (the MCP index and skill catalog are unchanged), so there is no regeneration commit.

Testing

Closes #385

Summary by CodeRabbit

  • Documentation
    • Clarified that the migration skill is bundled with new create-bestax projects.
    • Documented that migration guidance remains inactive unless legacy imports are detected.
    • Updated release and synchronization guidance to keep related tooling and documentation aligned.

…#385)

Direction (B) from #385: the skill stays in the create-bestax bundle.
Drop the two remaining not-bundled statements (skills intro, migrate page),
replace the contested note in bestax-migrate/CLAUDE.md with the settled
policy, and cite the decision from create-bestax/CLAUDE.md's per-skill
rule. No behavior changes; sync-skills.mjs and setupSkills() are
untouched, and pnpm gen produced no diff.
Copilot AI balanced review requested due to automatic review settings August 13, 2026 12:53
@coderabbitai

coderabbitai Bot commented Aug 13, 2026 •

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@allxsmith, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 31 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 06631d31-febe-4ca7-b11b-2651db14cdc6

📥 Commits

Reviewing files that changed from the base of the PR and between 3758a91 and 3be3db5.

📒 Files selected for processing (3)
  • bestax-migrate/CLAUDE.md
  • create-bestax/CLAUDE.md
  • docs/docs/skills/migrate.mdx

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bcaefc96-a373-4ff5-97d9-0b5f2401c583

📥 Commits

Reviewing files that changed from the base of the PR and between 3a7dd89 and 3758a91.

📒 Files selected for processing (4)
  • bestax-migrate/CLAUDE.md
  • create-bestax/CLAUDE.md
  • docs/docs/skills/intro.md
  • docs/docs/skills/migrate.mdx

Walkthrough

The changes align bestax-migrate bundling guidance across authoring instructions and documentation. They state that create-bestax preinstalls the skill and that it activates when react-bulma-components imports are detected.

Changes

Bundling guidance alignment

Layer / File(s) Summary
Synchronize bundled skill guidance
bestax-migrate/CLAUDE.md, create-bestax/CLAUDE.md, docs/docs/skills/intro.md, docs/docs/skills/migrate.mdx
The guidance now states that bestax-migrate is bundled by create-bestax, remains inactive in fresh scaffolds until legacy imports are detected, and must stay synchronized across related references.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Mergeability Score: ⚪ Minimal · up to 3758a

This documentation-only change aligns the bundling guidance without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: claude

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the primary change: documenting that create-bestax ships the bestax-migrate skill.
Description check ✅ Passed The description explains the changes, affected files, rationale, testing, scope, and linked issue, with only template checkboxes omitted.
Linked Issues check ✅ Passed The changes satisfy issue #385 by aligning all specified documentation and preserving the existing bundling implementation.
Out of Scope Changes check ✅ Passed All changes are limited to the documentation updates required by issue #385, with no unrelated implementation changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/385-bundle-bestax-migrate

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Aligns documentation with the settled policy that create-bestax bundles the migration skill.

Changes:

  • Removes outdated “not bundled” guidance.
  • Documents the bundled, idle-until-needed behavior.
  • Records the synchronization policy for maintainers.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/docs/skills/migrate.mdx Describes preinstalled migration behavior.
docs/docs/skills/intro.md Removes obsolete bundling warning.
create-bestax/CLAUDE.md Records the settled bundling decision.
bestax-migrate/CLAUDE.md Documents policy and synchronization points.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

Preview URL: https://04de1f91.bestax.pages.dev

@claude claude Bot 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.

Deep review — 0 blocking · 1 advisory

# Severity Area Finding Location
1 🔵 Advisory Robustness Three "keep in agreement" guidance lists enumerate different roster sets (e.g. bestax-migrate/CLAUDE.md omits skills/README.md; create-bestax/CLAUDE.md omits sync-skills.mjs) — a future doc-drift risk, not a current inconsistency. bestax-migrate/CLAUDE.md:77

Overall: Sound, low-risk prose-only change that ratifies the settled #385 decision in the last four docs surfaces. I verified the code actually bundles the skill (sync-skills.mjs:23 SKILLS array and constants.ts:215 CLAUDE_MD roster both list bestax-migrate, and setupSkills() copies the whole bundle with no per-skill filter), so every new sentence matches shipped behavior and the #385 "Direction (B)" decision word-for-word. The riskiest thing here is simply whether the docs are now complete — and they are.

Residual risk:

  • Stale "not bundled" claims elsewhere — refuted: git grep -ni "not bundled" over *.md/*.mdx leaves only one hit in the 2-to-3 migration guide about bulma CSS bundling, unrelated to this skill; skills/README.md takes no bundling stance and lists the skill in all three of its rosters (table, install block, layout tree).
  • pnpm gen should have produced a regen commit — refuted: gen-mcp-index.mjs reads docs/docs/api/ and skills/*/SKILL.md, never docs/docs/skills/*.mdx, and grepping bestax-mcp/data/ for the changed prose ("not bundled", "Unlike the other skills") returns nothing; the indexed migrate description comes from SKILL.md, which this PR doesn't touch.
  • Rosters out of agreement after the edit — refuted: all functional rosters (sync-skills.mjs, constants.ts CLAUDE_MD, skills/README.md, docs/docs/skills/intro.md) currently include bestax-migrate; only the prose guidance lists differ (advisory #1).

Pure paperwork, dude — the code's been riding this wave since #345, the docs just finally paddled out to catch up with #385. Clean, no gnarly wipeouts, ship it.

The deep review flagged that this file's keep-in-agreement list and the
one in create-bestax/CLAUDE.md enumerate different sets, which is how
the original drift happened. One canonical list beats two copies:
reference create-bestax/CLAUDE.md's sync rules instead of restating.
Copilot AI review requested due to automatic review settings August 13, 2026 13:16
@allxsmith

Copy link
Copy Markdown
Owner Author

Addressed the advisory in f3810b2: instead of aligning two hand-copied rosters (which is exactly how the original drift happened), bestax-migrate/CLAUDE.md now points at the canonical list in create-bestax/CLAUDE.md's sync rules and restates nothing. One list, one owner. On the second half of the finding: create-bestax/CLAUDE.md's list does cover sync-skills.mjs, just as "the allowlist", which the same bullet defines two sentences earlier.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

Suppressed comments (2)

docs/docs/skills/migrate.mdx:17

  • create-bestax does not preinstall skills unconditionally: users can decline the prompt or pass --no-skills, and setupSkills() only runs when that choice is enabled (create-bestax/src/project-creator.ts:571-602). Qualify this sentence so the docs do not promise the migration skill in every scaffold.
Like the rest of the bundle, `create-bestax` preinstalls this skill; it stays idle until the
agent meets code that still imports `react-bulma-components`.

create-bestax/CLAUDE.md:27

  • The new bestax-migrate/CLAUDE.md text delegates the canonical bundling-surface roster to this rule, but this list omits docs/docs/skills/migrate.mdx, which now contains the explicit bundling claim. That leaves the newly corrected page outside the sync policy and does not fully implement the PR's stated “docs skills pages” agreement list.
  decision (bestax-migrate's was settled as bundled, #385) — when adding a skill, decide it
  explicitly and keep the allowlist, `skills/README.md`, `docs/docs/skills/intro.md`, and
  the `CLAUDE_MD` roster in `src/constants.ts` in agreement. **Never edit the bundled copy** — change `skills/` at the

@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

Preview URL: https://1194c5bb.bestax.pages.dev

Two suppressed Copilot findings, both real. setupSkills() only runs
when the user accepts the prompt or passes --skills, so migrate.mdx now
says offers to preinstall, matching intro.md. And with
bestax-migrate/CLAUDE.md delegating to the canonical roster, that roster
now names per-skill docs pages that state bundling, so migrate.mdx sits
inside the sync policy.
Copilot AI review requested due to automatic review settings August 13, 2026 13:22
@allxsmith

Copy link
Copy Markdown
Owner Author

Also picked up Copilot's two suppressed comments in 3be3db5, both fair: migrate.mdx now says "offers to preinstall" (setupSkills() only runs when the user accepts the prompt or passes --skills, and intro.md already used that phrasing), and the canonical roster in create-bestax/CLAUDE.md now covers per-skill docs pages that state bundling, so migrate.mdx sits inside the sync policy it prompted.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@github-actions

Copy link
Copy Markdown
Contributor

Preview Deployment

Preview URL: https://1dac66f0.bestax.pages.dev

@allxsmith
allxsmith merged commit 92059da into main Aug 13, 2026
26 checks passed
@allxsmith
allxsmith deleted the docs/385-bundle-bestax-migrate branch August 13, 2026 13:30
@bestax-release-bot

Copy link
Copy Markdown

🎉 This PR is included in version 5.11.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@bestax-release-bot

Copy link
Copy Markdown

🎉 This PR is included in version 2.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@bestax-release-bot

Copy link
Copy Markdown

🎉 This PR is included in version 4.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@bestax-release-bot

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

[Bug] Settled: create-bestax bundles the bestax-migrate skill; two docs still say otherwise

2 participants