docs: flatten facilities, generate asset binding, tabulate TomoWise specs#291
Open
xmap wants to merge 2 commits into
Open
docs: flatten facilities, generate asset binding, tabulate TomoWise specs#291xmap wants to merge 2 commits into
xmap wants to merge 2 commits into
Conversation
…site descriptor The facility surface had one hand-authored page left: per-site assets.md. Everything it carried (the beamline root-Asset binding, tier, facility_code) is already in the site descriptor, so fold it into the generated index page and delete the hand-authored files. This makes the whole facility surface descriptor-generated from site.yaml, and lets the nav drop a level: the "Facility envelope" group becomes a flat "Facilities" with APS and MAX IV as single leaves instead of each owning an Assets sub-page. deployments/index.md retires the "facility envelope" framing for plain "facilities" and drops the scope-levels table now that each facility page carries its own Asset binding inline. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…on from enclosure The TomoWise endstations and detector pages listed hardware as bullets while the generated pages (inventory, beamline, site) and 2-BM use tables inside framed sections. Convert the per-station and per-detector enumerations to spec tables (component, family, key specs, model/status) and keep the connective prose. Also clarify that an endstation is an equipment grouping label, not a modeled aggregate: the access-gated hutch is the Enclosure on a separate axis. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Coverage report
This PR does not seem to contain any modification to coverable code. |
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
Two related docs simplifications for the deployments section.
1. Facilities flatten + descriptor-generated asset binding
assets.mdwas the only hand-authored facility page; everything it carried (beamline root-Asset binding,tier,facility_code) is already insite.yaml. Folded it into the generated index page (_modeled()inscripts/site_pages.py) and deleted the hand-authored files. The whole facility surface is now descriptor-generated.Facility envelope > APS > {index, Assets}becomes a flatFacilities > APS/MAX IV(single leaves).deployments/index.mdretires the "facility envelope" framing for "facilities" and drops the scope-levels table now that each facility page carries its Asset binding inline.2. TomoWise equipment tables + vocabulary clarifier
endstations.mdanddetector.mdhardware enumerations from bullets to per-section spec tables (component, family, key specs, model/status), matching the generated pages and 2-BM. Connective prose kept.controls.md(prose) andequipment/index.md(linked overview) left unchanged.Verification
make docs-build(mkdocs build --strict): exit 0; new Enclosure-module link resolves; no warnings touch the changed pages.pytest tests/unit/deployments/test_site_descriptor.py: 11 passed (asserts the binding table is folded in andassets.mdis no longer referenced).🤖 Generated with Claude Code