Skip to content

feat(rules_score): group architectural design views in software_arch docs - #455

Open
vishwajitdandage wants to merge 1 commit into
eclipse-score:mainfrom
vishwajitdandage:group-arch-design
Open

feat(rules_score): group architectural design views in software_arch docs#455
vishwajitdandage wants to merge 1 commit into
eclipse-score:mainfrom
vishwajitdandage:group-arch-design

Conversation

@vishwajitdandage

@vishwajitdandage vishwajitdandage commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

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_element aggregated all architectural design inputs, feature requirements, and safety analyses into a single flat .. toctree:: list in software_arch.rst, making long architecture documentation pages hard to navigate.

Solution

  1. Providers: Expose static_doc_files, dynamic_doc_files, public_api_doc_files, and internal_api_doc_files in ArchitecturalDesignInfo.
  2. Architectural Design Rule: Separate RST wrapper creation by view type and preserve relative subdirectory structures in _colocate_puml_with_wrapper.
  3. Dependable Element Rule: Classify architectural documentation files by view type and render subheadings with dedicated .. toctree:: blocks when category metadata is available.

Proposed vs Current

image

…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.
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