docs(equipment): add Cross-aggregate invariants section#48
Merged
Conversation
The equipment module page describes Mount and Fixture separately under Aggregates but never contrasts them, and never spells out the guard family that ties Asset, Mount, and Fixture together. A solo dev reading the page in isolation can conflate "slot" between `Mount.slot_code` (a facility-unique physical bay) and `SlotAssetBinding.slot_name` (a template-local key drawn from the Assembly's required_slots). Adds a new top-level section between `Slices` and `Storage & Projections` that covers: - One-paragraph Mount-vs-Fixture role contrast (where each fits). - An explicit gloss of the "slot" vocabulary overload. - A four-axis comparison table (cardinality, lifecycle, relation graph, back-reference shape). - A table of the four cross-aggregate guards landed in slices 1, 2, and 3a (decommission_asset's two HAS/IS guards, uninstall_asset's fixture-bound guard, register_fixture's not-attachable guard). - A ten-step recommended choreography that walks register_asset through decommission_asset, with the note that the install / detach / uninstall / decommission ordering on the teardown side is what the four guards enforce. The orphan-binding guard from slice 3b is intentionally NOT documented here because that slice has not yet landed on main; this docs slice can be amended once 3b merges. Pure docs change. No source edits, no test edits. The mkdocs strict-mode build aborts on a pre-existing warning unrelated to this file (`reference/conventions.md` -> `projects/supply.md` link gap from a prior change). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
1 participant
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.
Summary
Adds a new top-level section between
SlicesandStorage & Projectionsindocs/architecture/modules/equipment/index.mdthat documents how Mount, Fixture, and Asset compose at runtime.The page previously described Mount and Fixture separately under
Aggregatesbut never contrasted them, and never spelled out the guard family that ties Asset, Mount, and Fixture together. A solo dev reading the page in isolation can conflate "slot" betweenMount.slot_code(a facility-unique physical bay) andSlotAssetBinding.slot_name(a template-local key drawn from the Assembly'srequired_slots).What's added
AssetHasFixtureBindingError,AssetIsInstalledError,MountHasFixtureBoundAssetError,FixtureAssetNotAttachableError)register_assetthroughdecommission_assetThe orphan-binding guard from slice 3b is intentionally NOT documented here because that slice has not yet landed on main (PR #44 in review); this docs slice can be amended once 3b merges.
Test plan
reference/conventions.md->projects/supply.mdlink gap from a prior change), confirmed by stash-and-build comparison.\U0001f916 Generated with Claude Code