feat(rules_score): group architectural design views in software_arch docs - #455
Open
vishwajitdandage wants to merge 1 commit into
Open
feat(rules_score): group architectural design views in software_arch docs#455vishwajitdandage wants to merge 1 commit into
vishwajitdandage wants to merge 1 commit into
Conversation
vishwajitdandage
requested review from
LittleHuba,
castler,
hoe-jo,
limdor and
ramceb
as code owners
September 2, 2026 09:22
…docs Why: software_arch.rst rendered architectural design entries as a single flat list without grouping, making complex architecture pages hard to navigate. What: track static, dynamic, public_api, and internal_api doc files in ArchitecturalDesignInfo and generate subheadings with dedicated toctree blocks in dependable_element.
vishwajitdandage
force-pushed
the
group-arch-design
branch
from
September 2, 2026 10:31
a9b2db2 to
5c02ef6
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.
Summary
Group entries on the
Software Architectural Level(software_arch.rst) Sphinx documentation page into logical sub-sections (Requirements,Static Design,Dynamic Design,Public API,Internal API,Dependability Analysis).Problem
Previously,
dependable_elementaggregated all architectural design inputs, feature requirements, and safety analyses into a single flat.. toctree::list insoftware_arch.rst, making long architecture documentation pages hard to navigate.Solution
static_doc_files,dynamic_doc_files,public_api_doc_files, andinternal_api_doc_filesinArchitecturalDesignInfo._colocate_puml_with_wrapper... toctree::blocks when category metadata is available.Proposed vs Current