docs(bss-ledger): add canonical DESIGN.md to fix CFS ref-target-not-in-scope#6
Closed
diffora wants to merge 1 commit into
Closed
docs(bss-ledger): add canonical DESIGN.md to fix CFS ref-target-not-in-scope#6diffora wants to merge 1 commit into
diffora wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a canonical design index for the BSS Billing Ledger and rewrites the design-set README to point to it and the slice documents. The changes update architecture, constraints, traceability, and directory-level documentation only. ChangesLedger Design Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
The Billing Ledger kept its technical design as a design/ folder (foundation + per-slice docs), so Constructor Studio found no DESIGN artifact in the ledger system's scope: ADR-0001 (cpt-cf-bss-ledger-adr-book-ownership-predicate) had no DESIGN artifact to be referenced from, and cfs-validate failed with ref-target-not-in-scope. Add docs/DESIGN.md as the canonical DESIGN artifact and single index for the ledger, aligning it with every other gear (single DESIGN.md at the gear docs root). It carries the architecture overview, the phased slice map + dependency order (moved in from design/README.md so there is one index, not two), the cross-cutting normative statements as principle/constraint ids, the component/seq id definitions the template requires, and the ADR index. Detailed, normative per-slice design continues to live in design/; design/README.md is reduced to a folder-local pointer to ../DESIGN.md. Resolves the ledger ref-target-not-in-scope CFS error.
diffora
force-pushed
the
fix/bss-ledger-cfs-design-artifact
branch
from
July 8, 2026 19:23
f54ed0c to
a81d1b1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
gears/bss/ledger/docs/DESIGN.mdas the canonical Constructor Studio DESIGN artifact for the Billing Ledger.Why
The Billing Ledger kept its technical design as a
design/folder (foundation + per-slice docs) — it is the only gear that does this; every other gear has a singleDESIGN.mdat the gear docs root. Constructor Studio recognises a DESIGN artifact by that canonical file, so for the ledger system it found no DESIGN artifact in scope. As a result ADR-0001 (cpt-cf-bss-ledger-adr-book-ownership-predicate) had no DESIGN artifact to be referenced from, andcfs validatefailed:This surfaced as a red Validate CFS Artifacts check. Note:
mainitself is green (unchanged artifacts are not hard-failed), but any PR whose diff brings the ledger into strict validation scope inherits the failure — e.g. it is currently one of the CFS errors on the credstore PR.What the DESIGN.md contains
Modeled on the existing passing gears (e.g.
quota-enforcement) so it validates cleanly:cpt-cf-bss-ledger-design-maindesign id + the requiredprinciple/constraint/component/seqid definitions under their template sections.cpt-cf-bss-ledger-adr-book-ownership-predicate— this is what closes the error.design/; this document is the canonical index/overview and delegates slice specifics there, so the design set stays the single source of truth.No component is broken out into a
DECOMPOSITIONartifact (kept as a design-level factoring), matching the convention of other DESIGN-only gears.Verification
make cfs-validateon this branch: 183 artifacts, 0 errors (PASSED).ref-target-not-in-scopeerror is eliminated and no new ledger error/warning is introduced.Scope
Ledger only. The remaining two CFS
ref-target-not-in-scopeerrors —gears/model-registry(DESIGN components need aDECOMPOSITION) andgears/system/oagw(cpt-cf-oagw-feature-tenant-hierarchyneeds aFEATURE) — are owned by other gears and are intentionally left for their owners.Summary by CodeRabbit