Skip to content

docs(tomowise): align the beamline nav with 2-BM (Source/Sample/Detector) + tabulate devices#305

Merged
xmap merged 1 commit into
mainfrom
docs/tomowise-beamline-nav-align
Jun 22, 2026
Merged

docs(tomowise): align the beamline nav with 2-BM (Source/Sample/Detector) + tabulate devices#305
xmap merged 1 commit into
mainfrom
docs/tomowise-beamline-nav-align

Conversation

@xmap

@xmap xmap commented Jun 22, 2026

Copy link
Copy Markdown
Owner

Follow-up to #301. Aligns the TomoWISE beamline documentation with the 2-BM structure.

  • Nav spine: rename Endstations -> Sample (the descriptor's sample stage) so both deployments read Source / Sample / Detector / Controls / Inventory. The page file is git mv-renamed endstations.md -> sample.md; the two endstations live on as ## Microtomography / ## Nanotomography sub-sections.
  • Tables: convert the Sample and Detector device listings from bullet lists to Device | Family | target model | spec tables, matching the generated Source page and the Inventory.
  • Router: align equipment/index.md to 2-BM's Stations / Shared / Reference structure.
  • Design-phase depth kept lighter than 2-BM's materialized-fixture pages (no fabricated containment trees or exercised-model sections, since TomoWISE has no registered fixtures yet).

mkdocs --strict clean (rename leaves no broken links); deployment unit tests pass.

🤖 Generated with Claude Code

…tor) + tabulate devices

Match the cross-deployment beamline spine. Rename the nav entry and page
Endstations -> Sample (the descriptor's `sample` stage), keeping the two
endstations (microtomography ~45 m, nanotomography ~49 m) as sub-sections.
Convert the Sample and Detector device listings from bullet lists to tables
(Device | Family | target model | spec), matching the generated Source page
and the Inventory. Align equipment/index.md to 2-BM's Stations / Shared /
Reference router.

Design-phase depth stays lighter than 2-BM's materialized-fixture pages: no
fabricated model-in-one-picture trees or exercised-model sections, since
TomoWISE has no registered fixtures yet.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@xmap xmap enabled auto-merge (squash) June 22, 2026 07:33
@github-actions

Copy link
Copy Markdown

Coverage report

This PR does not seem to contain any modification to coverable code.

@xmap xmap merged commit 9852640 into main Jun 22, 2026
16 checks passed
@xmap xmap deleted the docs/tomowise-beamline-nav-align branch June 22, 2026 07:43
xmap added a commit that referenced this pull request Jun 22, 2026
…e + Detector) (#306)

Full-alignment follow-up to #305. Add the 2-BM-style "model in one picture":

- Detector: a containment tree (gantry -> microscopes -> constituents) and a
  PLANNED Microscope-assembly composition diagram (slot -> device), marked
  design-phase since no Fixture is registered yet; camera + propagation_distance
  shown as the ZeroOrOne decoupled slots, plus a Families note.
- Sample: containment trees for both endstation manipulators, with a note that
  the sample stage is a device group rather than a catalog Assembly (so no
  composition diagram), unlike 2-BM's SampleTower.

Tables retained. No materialized-only sections (vendor part numbers, selector
internals, calibrations, exercised model): TomoWISE has no registered fixtures.

mkdocs --strict and deployment unit tests pass.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
xmap added a commit that referenced this pull request Jun 22, 2026
…site asset binding

Salvages the unique half of the closed #291 (the TomoWISE-tabulation half is
already done by #305, so it is omitted here).

- Rename: the "Facility envelope" nav section and the index.md heading/prose
  become "Facilities"; each Site collapses from a {index, Assets} subsection to
  a single index entry.
- Flatten + generate: drop the standalone docs/deployments/{aps,maxiv}/assets.md
  pages; scripts/site_pages.py now generates the Asset-binding table
  (Asset | Tier | facility_code | Hosts) inline on each Site index from the
  descriptor (_modeled now takes facility_code + beamlines).
- index.md prose simplified (the three-row scope table folded into prose).

mkdocs --strict and the deployment unit tests (incl. test_site_descriptor) pass.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
xmap added a commit that referenced this pull request Jun 22, 2026
… asset binding (#307)

Salvages the unique half of the closed #291 (the TomoWISE-tabulation half is
already done by #305, so it is omitted here).

- Rename: the "Facility envelope" nav section and the index.md heading/prose
  become "Facilities"; each Site collapses from a {index, Assets} subsection to
  a single index entry.
- Flatten + generate: drop the standalone docs/deployments/{aps,maxiv}/assets.md
  pages; scripts/site_pages.py now generates the Asset-binding table
  (Asset | Tier | facility_code | Hosts) inline on each Site index from the
  descriptor (_modeled now takes facility_code + beamlines).
- index.md prose simplified (the three-row scope table folded into prose).

mkdocs --strict and the deployment unit tests (incl. test_site_descriptor) pass.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

1 participant