Skip to content

rules_score: Various improvements - #437

Draft
bemerybmw wants to merge 4 commits into
mainfrom
brem_safety_sentinel_add_dir_structure
Draft

rules_score: Various improvements#437
bemerybmw wants to merge 4 commits into
mainfrom
brem_safety_sentinel_add_dir_structure

Conversation

@bemerybmw

@bemerybmw bemerybmw commented Aug 21, 2026

Copy link
Copy Markdown
Contributor
  • Add static_view section to architecture_design. Units/ components in this section will not be used to define units/ components but will rather be checked for consistency against those in the static section. Allows creating views into the static design e.g. for creating diagrams showing interfaces for a subset of components.

  • Preserve PlantUML source directory structure in generated Sphinx documentation and create nested navigation indexes. Keep directory entries expandable but non-clickable in the sidebar, while retaining links for individual diagram pages.

Before:
image

After:
image

@bemerybmw
bemerybmw force-pushed the brem_safety_sentinel_add_dir_structure branch from f298a9a to 875de79 Compare August 21, 2026 09:29
bemerybmw and others added 2 commits August 21, 2026 11:49
`static_view` is an optional additional section for component diagrams that
present a partial view of the static architecture (e.g. a diagram scoped to a
subsystem). Diagrams passed to `static_view` are parsed like `static`, but are
never used to define the units/components validated against the Bazel
component graph. Instead, every component/unit defined in a `static_view`
diagram must also be defined, under the same parent, in `static`: it may only
contain a subset of the units/components of the matching `static` diagram.

The `static_view` section can be used for creating additional diagrams that
provide a view onto the architecture which make the design easier to view / understand.
E.g. you can create a diagram which shows a subset of components as showing all
components in one view may be too "busy". It can also be useful when showing the
interfaces between components. Adding all the interfaces in the diagrams in the
`static` view may result in too many interface lines which is not readable. Instead,
a view can be created with a subset of components and only the interfaces between these
chosen components can be shown.

Co-authored-by: GitHub Copilot <copilot@github.com>
Co-authored-by: GitHub Copilot <copilot@github.com>
@bemerybmw
bemerybmw force-pushed the brem_safety_sentinel_add_dir_structure branch 2 times, most recently from 36f6a54 to 12dd283 Compare August 21, 2026 13:20
@bemerybmw bemerybmw changed the title rules_score: Organize architectural diagrams by source directories rules_score: Various improvements Aug 21, 2026
bemerybmw and others added 2 commits August 21, 2026 16:45
Preserve PlantUML source directory structure in generated Sphinx
documentation and create nested navigation indexes. Keep directory
entries expandable but non-clickable in the sidebar, while retaining
links for individual diagram pages.

Co-authored-by: GitHub Copilot <copilot@github.com>
Permit files in different directories to share the same basename while
preserving path-based identity.

Co-authored-by: GitHub Copilot <copilot@github.com>
@bemerybmw
bemerybmw force-pushed the brem_safety_sentinel_add_dir_structure branch from 12dd283 to 209fece Compare August 21, 2026 14:46
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