Skip to content

Work on detail design warnings #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexanderLanin merged 1 commit into from
May 29, 2026
Merged

Work on detail design warnings #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ bazel_dep(name = "aspect_rules_lint", version = "1.10.2", dev_dependency = True)
bazel_dep(name = "buildifier_prebuilt", version = "8.5.1.2", dev_dependency = True)

#docs-as-code
bazel_dep(name = "score_docs_as_code", version = "4.0.3", dev_dependency = True)
bazel_dep(name = "score_docs_as_code", version = "4.2.0", dev_dependency = True)
bazel_dep(name = "score_process", version = "1.5.4", dev_dependency = True)

# grpc-java 1.66.0 imports a grpc extension repo removed in newer grpc versions.
Expand Down
10 changes: 7 additions & 3 deletions MODULE.bazel.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions examples/docs/architecture_modeling_example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Feature or Component Architecture File(s)
:id: comp__mod_temp_component_example_1
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid
:implements: logic_arc_int__example_feature__if_1
:consists_of: comp__mod_temp_archex_sub_component_1, comp__mod_temp_archex_sub_component_2, comp__mod_temp_archex_sub_component_3
:belongs_to: feat__mtef
Expand All @@ -204,7 +204,7 @@ Feature or Component Architecture File(s)
:id: comp__mod_temp_component_example_2
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid
:implements: logic_arc_int__example_feature__if_2
:belongs_to: feat__mtef

Expand All @@ -214,7 +214,7 @@ Feature or Component Architecture File(s)
:id: comp__mod_temp_component_example_3
:security: YES
:safety: QM
:status: invalid
:status: valid
:implements: logic_arc_int__example_feature__if_3
:belongs_to: feat__mtef

Expand Down
8 changes: 4 additions & 4 deletions score/component_example/docs/architecture/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,15 @@ A component can optional also consist of lower level components to further struc
:id: comp__mod_temp_component_name_template
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid
:consists_of: comp__mod_temp_archex_sub_component_1, comp__mod_temp_archex_sub_component_2, comp__mod_temp_archex_sub_component_3
:belongs_to: feat__mtef

.. comp_arc_sta:: Component Name (Static View)
:id: comp_arc_sta__mod_temp_component_name__sv
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title

Expand All @@ -101,7 +101,7 @@ Dynamic Architecture
:id: comp_arc_dyn__mod_temp_component_name__dv
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title

Expand All @@ -125,7 +125,7 @@ Internal Components

.. comp_arc_sta:: Component Name Static View
:id: comp_arc_sta__mod_temp_component_name__2
:status: invalid
:status: valid
:safety: ASIL_B
:security: YES
:fulfils: comp_req__mod_temp_component_name__some_title
Expand Down
5 changes: 5 additions & 0 deletions score/component_example/docs/detailed_design/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
Detailed Design
###############

.. attention::

The detailed design document is optional and should be created if the design of the component is complex and cannot be easily understood from the architecture documentation and interface documentation alone.


.. document:: [Your Component Name] Detailed Design
:id: doc__mod_temp_component_name_detailed_design
:status: draft
Expand Down
4 changes: 2 additions & 2 deletions score/component_example/docs/requirements/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Component Requirements
:security: YES
:safety: ASIL_B
:satisfies: feat_req__example_feature__example_req
:status: invalid
:status: valid
:belongs_to: comp__mod_temp_component_name_template

The Component shall do xyz to another component to bring it to this condition at this time
Expand All @@ -68,7 +68,7 @@ Assumption of Use Requirements
:reqtype: Process
:security: YES
:safety: ASIL_B
:status: invalid
:status: valid

The Component User shall do xyz to use the component safely/securely

Expand Down
Loading