Skip to content

docs: complete package split evaluation - #169

Merged
wpak-ai merged 1 commit into
cppalliance:mainfrom
jonathanMLDev:doc/update-splite-evaluation
Jun 22, 2026
Merged

docs: complete package split evaluation#169
wpak-ai merged 1 commit into
cppalliance:mainfrom
jonathanMLDev:doc/update-splite-evaluation

Conversation

@jonathanMLDev

@jonathanMLDev jonathanMLDev commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

Updates docs/PACKAGE_SPLIT_EVAL.md to finish the core vs Alliance npm package split evaluation. Recommends split later (target 1.0) with interim barrel-export tightening while the package stays unified.

Changes

  • Refresh architecture snapshot: 8 core tools (including guided_query), 9 Alliance tools (suggest_query_params only)
  • Add §2.5 — eval §5.3 coherence cost: disableSuggestFlow default divergence
  • Add §2.6guided_query placement decision (core; no third package)
  • Expand §3.4 — shared dependency count (4 prod deps), version alignment burden, npm/pnpm/Turborepo/Lerna/Nx tradeoffs
  • Add §4.5 — quantified import breakage (~12 programmatic sites, ~4 MCP configs)
  • Add §6.1 — interim barrel-export plan while unified (export * → named re-exports, trim internal types)
  • Update executive summary, references, and prerequisite checklist

Recommendation

Decision Rationale
Split later (not now) Legacy facades still in core exports; no workspace tooling yet; low external adoption pressure
Split at 1.0 Preferred window — combine with facade removal
Interim Tighter barrel exports per §6.1

Test plan

  • Documentation only — no code changes
  • Verified against week-plan Item 6 acceptance criteria
  • Aligns with current codebase (guided_query in core, cross-entry-point test exists)

Related Issue

Summary by CodeRabbit

  • Documentation
    • Updated internal architecture planning documentation with refined decision framework, clarified component responsibilities, and expanded tooling analysis guidance.

@jonathanMLDev jonathanMLDev self-assigned this Jun 19, 2026
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jonathanMLDev, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 45 minutes and 22 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

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 credits.

🚦 How do rate limits work?

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

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, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2b9da323-fdda-46c1-9ee4-867e4ecb1d10

📥 Commits

Reviewing files that changed from the base of the PR and between 2421a2e and a082211.

📒 Files selected for processing (1)
  • docs/PACKAGE_SPLIT_EVAL.md
📝 Walkthrough

Walkthrough

Updates docs/PACKAGE_SPLIT_EVAL.md to refine the package-split evaluation: decision section specifies deferred split with guided_query in core; architecture snapshot adjusts tool counts and import estimates; feasibility analysis adds ownership clarity, shared-dependency burden, and monorepo tooling tradeoffs; consumer-impact section expands import-breakage tables and export-trimming guidance; interim-measures checklist is extended and Release 1 prerequisites are marked complete.

Changes

Package Split Evaluation Document

Layer / File(s) Summary
Decision section and architecture snapshot
docs/PACKAGE_SPLIT_EVAL.md
Decision section updated with split-later timing, guided_query placement in core, and a disableSuggestFlow divergence note; source-layout table revised with updated tool counts and line estimates; mermaid diagram import-statement count corrected.
guided_query ownership and disableSuggestFlow divergence
docs/PACKAGE_SPLIT_EVAL.md
Rewrites the guided_query/Alliance-vs-core narrative with tool registration counts and setup behavior; expands disableSuggestFlow divergence discussion covering entry points and gate behavior; adds clear-ownership bullet to the feasibility verdict contrasting core generic tools vs Alliance domain config.
Shared dependencies, monorepo tooling, and CI matrix
docs/PACKAGE_SPLIT_EVAL.md
Adds shared runtime dependency breakdown with alignment-burden and failure-mode description; elaborates npm/pnpm/turbo/lerna/nx orchestration tradeoffs with a recommended direction; adds CI matrix bullet requiring Alliance tests against pinned and latest compatible core.
Version cadence and quantified import breakage
docs/PACKAGE_SPLIT_EVAL.md
Refines version cadence motivation list by splitting core-infrastructure vs Alliance-only changes; expands import-breakage section with a per-pattern table (sites, break status, migration steps); adds export-trimming note and identifies internal hybrid types to remove before 1.0.
Recommendation, interim measures, and references
docs/PACKAGE_SPLIT_EVAL.md
Updates keep-unified cons with remaining coupling factors; adjusts rationale item 4 for subpath exports including guided_query in core; expands interim-measures table with barrel trimming, export * replacement, divergence documentation, integration tests, and deprecations; marks Release 1 prerequisites complete; expands references list.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • AuraMindNest
  • leostar0412
  • wpak-ai

Poem

🐇 Hop, hop through the docs we go,
Trimming barrels, high and low,
guided_query finds its core,
Alliance carves its own front door.
No split today—but soon, oh my!
A cleaner package by and by. 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: complete package split evaluation' directly and concisely describes the main change—completing the documentation update for the package split evaluation decision.
Linked Issues check ✅ Passed The PR comprehensively addresses all coding-related requirements from issue #158: evaluates shared dependencies (4 production), quantifies consumer impact (~12 sites, ~4 configs), discusses CI complexity and publishing workflow, clearly recommends deferring split to 1.0, proposes interim barrel-export improvements, and references disableSuggestFlow coherence cost.
Out of Scope Changes check ✅ Passed All changes remain within scope—the PR is documentation-only, updating PACKAGE_SPLIT_EVAL.md to address issue #158 requirements with no extraneous modifications to unrelated files or functionality.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@codecov

codecov Bot commented Jun 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@2421a2e). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #169   +/-   ##
=======================================
  Coverage        ?   87.56%           
=======================================
  Files           ?       40           
  Lines           ?     1664           
  Branches        ?      546           
=======================================
  Hits            ?     1457           
  Misses          ?      207           
  Partials        ?        0           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jonathanMLDev

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@AuraMindNest
AuraMindNest requested a review from wpak-ai June 19, 2026 16:54
@wpak-ai
wpak-ai merged commit 38b9f84 into cppalliance:main Jun 22, 2026
12 checks passed
@jonathanMLDev
jonathanMLDev deleted the doc/update-splite-evaluation branch June 22, 2026 18:32
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.

Package Split Evaluation: Assess Core vs Alliance as Separate npm Packages

3 participants