Skip to content

Doing doc update #400

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
MaciejKaszynski merged 2 commits into from
Aug 3, 2026
Merged

Doing doc update #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
779ebf3
Doing doc update
MaciejKaszynski Aug 3, 2026
a4fdd33
Adding back arch doc
MaciejKaszynski Aug 3, 2026
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
4 changes: 2 additions & 2 deletions MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ bazel_dep(name = "google_benchmark", version = "1.9.5", dev_dependency = True)
# S-CORE process rules

bazel_dep(name = "score_bazel_platforms", version = "0.1.2", dev_dependency = True)
bazel_dep(name = "score_docs_as_code", version = "4.6.1", dev_dependency = True)
bazel_dep(name = "score_docs_as_code", version = "6.0.0", dev_dependency = True)
bazel_dep(name = "score_tooling", version = "1.3.1", dev_dependency = True)
bazel_dep(name = "score_rust_policies", version = "0.0.5", dev_dependency = True)
bazel_dep(name = "score_cpp_policies", version = "0.0.1", dev_dependency = True)
bazel_dep(name = "score_process", version = "2.0.2", dev_dependency = True)
bazel_dep(name = "score_platform", version = "0.6.2", dev_dependency = True)
bazel_dep(name = "score_platform", version = "0.6.3", dev_dependency = True)

## Configure the C++ toolchain
bazel_dep(name = "score_bazel_cpp_toolchains", version = "0.5.4", dev_dependency = True)
Expand Down
13 changes: 9 additions & 4 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.

3 changes: 2 additions & 1 deletion docs/features/lifecycle/architecture/chklst_arc_inspection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@
.. document:: Lifecycle Architecture Inspection Checklist
:id: doc__lifecycle_arc_inspection
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__sw_arch_verification
:realizes: wp__sw_arch_verification[version==1]

Architecture Inspection Checklist
=================================
Expand Down
5 changes: 3 additions & 2 deletions docs/features/lifecycle/architecture/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ Feature Architecture
====================

.. document:: Lifecycle Architecture
:id: doc__lifecycle_architecture
:id: doc__lifecycle_architecture_feature
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__feature_arch
:realizes: wp__feature_arch[version==1]

Overview
--------
Expand Down
4 changes: 3 additions & 1 deletion docs/features/lifecycle/safety_analysis/aou_requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ AoU Feature Requirements
.. document:: Lifecycle Feature AoU
:id: doc__lifecycle_feat_aou
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__requirements_feat_aou
:realizes: wp__requirements_feat_aou[version==1]

Feature AoU
-----------
Expand All @@ -33,5 +34,6 @@ Feature AoU
:security: NO
:safety: ASIL_B
:status: invalid
:version: 1
The Feature User shall do xyz to use the feature safely.
4 changes: 3 additions & 1 deletion docs/features/lifecycle/safety_analysis/dfa.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ DFA (Dependent Failure Analysis)
.. document:: Lifecycle DFA
:id: doc__lifecycle_dfa
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__feature_dfa
:realizes: wp__feature_dfa[version==1]

.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.

Expand Down Expand Up @@ -189,6 +190,7 @@ For all identified applicable failure initiators, the DFA is performed in the fo
:mitigation_issue: <ID from Issue Tracker>
:sufficient: <yes|no>
:status: <valid|invalid>
:version: 1

.. note:: Argument is inside the 'content'. Therefore content is mandatory.

Expand Down
4 changes: 3 additions & 1 deletion docs/features/lifecycle/safety_analysis/fmea.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ FMEA (Failure Modes and Effects Analysis)
.. document:: Lifecycle FMEA
:id: doc__lifecycle_fmea
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__feature_fmea
:realizes: wp__feature_fmea[version==1]

.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.

Expand Down Expand Up @@ -117,6 +118,7 @@ For all identified applicable failure initiators, the FMEA is performed in the f
:mitigation_issue: <ID from Issue Tracker>
:sufficient: <yes|no>
:status: <valid|invalid>
:version: 1

.. note:: Argument is inside the 'content'. Therefore content is mandatory.

Expand Down
3 changes: 2 additions & 1 deletion docs/features/lifecycle/safety_planning/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Feature Safety Work Products List
.. document:: Lifecycle Safety WPs
:id: doc__lifecycle_safety_wp
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__platform_safety_plan
:realizes: wp__platform_safety_plan[version==1]

Tailoring
=========
Expand Down
3 changes: 2 additions & 1 deletion docs/features/lifecycle/security_planning/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Feature Security Work Products List
.. document:: Lifecycle Security WPs
:id: doc__lifecycle_security_planning_wp
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__platform_security_plan
:realizes: wp__platform_security_plan[version==1]

Tailoring
=========
Expand Down
3 changes: 2 additions & 1 deletion docs/manuals/safety_manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Safety Manual
.. document:: Lifecycle Safety Manual
:id: doc__lifecycle_safety_manual
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__module_safety_manual
:realizes: wp__module_safety_manual[version==1]

Introduction/Scope
------------------
Expand Down
3 changes: 2 additions & 1 deletion docs/manuals/security_manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Security Manual
.. document:: Lifecycle Security Manual
:id: doc__lifecycle_security_manual
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__module_security_manual
:realizes: wp__module_security_manual[version==1]


Introduction/Scope
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/user_manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ User Manual
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path
:realizes: wp__training_path[version==1]


Overview
Expand Down
3 changes: 2 additions & 1 deletion docs/release/release_note_v_0_2_0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
.. document:: lifecycle Release Note v0.2.0
:id: doc__lifecycle_release_note_v0_2_0
:status: valid
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__module_sw_release_note
:realizes: wp__module_sw_release_note[version==1]
:tags:


Expand Down
3 changes: 2 additions & 1 deletion docs/release/release_note_v_0_3_0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
.. document:: lifecycle Release Note v0.3.0
:id: doc__lifecycle_release_note_v0_3_0
:status: valid
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__module_sw_release_note
:realizes: wp__module_sw_release_note[version==1]
:tags:


Expand Down
3 changes: 2 additions & 1 deletion docs/safety_mgt/module_safety_analysis_fdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Safety Analysis Checklist
.. document:: Lifecycle Safety Analysis Checklist
:id: doc__lifecycle_safety_analysis_fdr
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__fdr_reports
:realizes: wp__fdr_reports[version==1]


**Purpose**
Expand Down
3 changes: 2 additions & 1 deletion docs/safety_mgt/module_safety_package_fdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Safety Package Formal Review Report
.. document:: Lifecycle Safety Package Formal Review
:id: doc__lifecycle_safety_package_fdr
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__fdr_reports
:realizes: wp__fdr_reports[version==1]


**Purpose**
Expand Down
3 changes: 2 additions & 1 deletion docs/safety_mgt/module_safety_plan.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Safety Plan
.. document:: Lifecycle Safety Plan
:id: doc__lifecycle_safety_plan
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__module_safety_plan
:realizes: wp__module_safety_plan[version==1]

:note: The module safety plan shall be continuously maintained during the project.
Deviations to the module safety plan should be documented :ref:`here <lifecycle_safety_package_deviations>`
Expand Down
3 changes: 2 additions & 1 deletion docs/safety_mgt/module_safety_plan_fdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Safety Plan Formal Review Report
.. document:: Lifecycle Safety Plan Formal Review
:id: doc__lifecycle_safety_plan_fdr
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__fdr_reports
:realizes: wp__fdr_reports[version==1]

**Purpose**

Expand Down
3 changes: 2 additions & 1 deletion docs/security_mgt/module_security_package_fdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Security Package Formal Review Report
.. document:: Lifcycle Security Package Formal Review
:id: doc__lifecycle_sec_pkg_fdr
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__fdr_reports
:realizes: wp__fdr_reports[version==1]


**1. Purpose**
Expand Down
3 changes: 2 additions & 1 deletion docs/security_mgt/module_security_plan.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ Security Plan
.. document:: Lifecycle Security Plan
:id: doc__lifecycle_security_plan
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__module_security_plan
:realizes: wp__module_security_plan[version==1]


| **1. Security Management Context**
Expand Down
3 changes: 2 additions & 1 deletion docs/security_mgt/module_security_plan_fdr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Security Plan Formal Review Report
.. document:: Lifecycle Security Plan Formal Review
:id: doc__lifecycle_security_plan_fdr
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__fdr_reports
:realizes: wp__fdr_reports[version==1]


**1. Purpose**
Expand Down
3 changes: 1 addition & 2 deletions score/health_monitor/docs/architecture/assets/hm_duration_range.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
@startuml

+struct TimeRange
{
+class TimeRange {
min: Duration
max: Duration
}
Expand Down
2 changes: 1 addition & 1 deletion score/health_monitor/docs/architecture/assets/lm_state.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
+new<N: AsRef<str>>(name: N) -> Self
}

@enduml
@enduml
3 changes: 2 additions & 1 deletion score/health_monitor/docs/architecture/chklst_arc_inspection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@
.. document:: Health Monitor Architecture Inspection Checklist
:id: doc__health_monitor_arc_inspection
:status: draft
:version: 1
:safety: ASIL_B
:security: YES
:realizes: wp__sw_arch_verification
:realizes: wp__sw_arch_verification[version==1]


Architecture Inspection Checklist
Expand Down
Loading
Loading