Skip to content

Commit

Permalink
docs: Update structure to reflect bazel modules
Browse files Browse the repository at this point in the history
Signed-off-by: ramceb <[email protected]>
  • Loading branch information
ramceb committed Jan 20, 2025
1 parent 9482827 commit 6b7b3d2
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/process/guidance/general/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following shows the folder structure of the platform repository (ordered alp
can be in a different order.

.. code-block:: text
@eclise-score/score/ -> Central repository for the platform
docs/ -> Global documentation of the platform.
concepts/ -> Description of overall concepts.
glossary/ -> Glossary of abbreviations used in the platform context.
Expand Down Expand Up @@ -72,9 +72,8 @@ can be in a different order.
tests/ -> Feature tests, consisting of ...
integration-tests/ -> ... integration tests [WP_FEATURE_INTEGRATION_TEST].
toolchain/ -> Definition of toolchain
modules/ -> Modules of the SW platform.
<module_name>/ -> Folder containing all artifacts corresponding to one module.

@eclise-score/<module_name>/ -> Repository all artifacts corresponding to one module.
docs/ -> Documentation of the module consisting of ...
manual/ -> ... Module manual, e.g. integration manual, assumptions of use and safety manual [WP_SW_COMPONENT_AOU], [WP_MODULE_SW_SAFETY_MANUAL].
release/ -> ... Module release note [WP_MODULE_SW_RELEASE_NOTE] plus safety assessment [WP_ASSESSMENT_REPORT]
Expand Down

0 comments on commit 6b7b3d2

Please sign in to comment.