Fix top-level documentation by rmaddikery · Pull Request #259 · eclipse-score/logging

rmaddikery · 2026-08-12T14:56:14Z

See rendered documentation here:
#259 (comment)

Fix top-level documentation

Adds high-level overview explaining the mw::log structure
Remove outdated documentation
Restructure documentation to where it fits

github-actions · 2026-08-12T14:57:30Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: c1eaed4e-326d-4326-870d-648b80964f38
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_process', the root module requires module version score_process@1.5.4, but got score_process@1.6.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 4 packages loaded
Loading: 4 packages loaded
    currently loading: 
Loading: 4 packages loaded
    currently loading: 
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
Analyzing: 0 targets (5 packages loaded)
INFO: Elapsed time: 12.941s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

github-actions · 2026-08-12T16:51:43Z

The created documentation from the pull request is available at: docu-html

arsibo

first formal findings

arsibo · 2026-08-14T08:33:46Z

A component's architecture describes how it is constructed from subcomponents. Since this component contains no subcomponents, this content should be moved to the detailed design section.

file_output_backend and datarouter_backend are not shown in this diagram

arsibo · 2026-08-14T08:37:30Z

+=====================
+
+.. comp:: Logging Component
+   :id: comp__mw_logging


Should mw_looging be the final component name? I thought we wanted to use log_backend in the logging repo and 'log' in the baselibs repo.

No. baselibs will have one dependable_element in which mw::log will be part of.
So we keep mw_log in score_logging and create a safety plan here.
in baselibs a sefetyplan will forward aous and link the score_logging safety plan

That means we will have three components in the logging feature

log in baselibs

mw_log in logging

datarouter in logging

right ? In the safety artifacts we working with references . That means the safety artifact for log (baseline) includes only an reference to mw_log (logging)

arsibo · 2026-08-14T08:42:55Z

The template https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/index.rst is not applied

arsibo · 2026-08-14T08:45:00Z

file shall be moved to ./mw_log/requirements/
See folder structure under <component_name>/ https://eclipse-score.github.io/score/main/contribute/general/folder.html

arsibo · 2026-08-14T08:45:41Z

Shall we add a folder _assets for that ?

arsibo · 2026-08-14T08:47:16Z

content shall be moved to docs/manuals/

arsibo · 2026-08-14T08:49:55Z

-
-.. comp:: Data Router
+.. comp:: Datarouter
   :id: comp__data_router


component id shall be 🆔 comp__datarouter due to folder name datarouter

arsibo · 2026-08-14T08:50:39Z

template shall be used https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/index.rst

arsibo · 2026-08-14T08:58:28Z

+   Runtime plugin loading remains experimental and is not a supported
+   production capability.
+
+   .. uml:: mw_log_repository_boundary.puml


this belongs to the feature architecture . Feature architecture has to be modeled in sphinx needs

arsibo · 2026-08-14T09:14:50Z

 written is less then requested.

-![Action Diagram](./score/mw/log/design/slot_drainer_action_diagram_design.puml)
+<img alt="SlotDrainerActionDiagram" src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/baselibs/refs/heads/main/score/mw/log/design/slot_drainer_action_diagram_design.puml">


puml file was not rendered

will be fixed after fixed in baselibs.

arsibo · 2026-08-14T09:26:13Z

The file shall be included as reference to detailed design or there should be folder on the rendered website design decisions

arsibo · 2026-08-14T09:35:13Z

file_output_backend and datarouter_backend are not shown in this diagram

arsibo · 2026-08-14T09:45:12Z

 ### Process structure

-[context-highlevel](uml/context-highlevel.puml)
+<img alt="CONTEXT_HIGHLEVEL" src="https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/eclipse-score/logging/refs/heads/main/score/datarouter/doc/design/uml/context-highlevel.puml">


Diagramm shows an Adptive Autosar ECU

arsibo · 2026-08-14T09:46:20Z

@@ -50,9 +50,9 @@ The following constraints influenced the logging infrastructure design:
 ## Context



chapter could be copied/moved to feature description

pawelrutkaq · 2026-08-14T12:04:01Z

-| `project_config.bzl`                | Project-specific metadata for Bazel macros        |
-| `LICENSE.md`                        | Licensing information                             |
-| `CONTRIBUTION.md`                   | Contribution guidelines                           |
+## 📂 Key Files


I would remove that, usless

pawelrutkaq · 2026-08-14T12:04:34Z


 ---

 ## ⚙️ `project_config.bzl`


would remove all that below for project_config.bzl

pawelrutkaq · 2026-08-14T12:04:56Z

@@ -35,84 +30,55 @@ It provides a **standardized project structure**, ensuring best practices for:
 ### 1️⃣ Clone the Repository


- Adds high-level overview of the mw::log decomposition - Remove outdated documentation - Restructure documentation to where it fits

- Fixes .puml rendering

- Replace duplicated content with redirection to single source that resides next to source code rendered by Sphinx

- Reflect score folder structure guideline - Adds high level architecture documentation and references related diagrams

arsibo · 2026-08-14T14:37:09Z

-   :safety: ASIL_B
+   :safety: QM
   :status: valid
   :implements: logic_arc_int__logging__logging


comp__datarouter don't implement logic_arc_int__logging__logging.
This interface is implemented by mw_log.

Feature logging defines logic_arc_int__logging__buffer

mw_log implements logic_arc_int__logging__buffer

datarouter uses logic_arc_int__logging__buffer

github-project-automation Bot added this to LOG - Logging FT Aug 12, 2026

github-project-automation Bot moved this to Backlog in LOG - Logging FT Aug 12, 2026

rmaddikery deployed to workflow-approval August 12, 2026 14:56 — with GitHub Actions Active

rmaddikery marked this pull request as ready for review August 12, 2026 16:40

rmaddikery requested review from 4og, antonkri, arsibo and pawelrutkaq as code owners August 12, 2026 16:40

rmaddikery mentioned this pull request Aug 12, 2026

docs: consolidate mw/log design diagrams into docs/components/ #190

Open

10 tasks

rmaddikery requested a deployment to workflow-approval August 12, 2026 17:36 — with GitHub Actions Waiting

rmaddikery marked this pull request as draft August 12, 2026 18:00

rmaddikery force-pushed the rama_fix_docu branch from 5ddc016 to 9ce6f8b Compare August 12, 2026 18:27

rmaddikery deployed to workflow-approval August 12, 2026 18:27 — with GitHub Actions Active

rmaddikery requested a deployment to workflow-approval August 12, 2026 18:56 — with GitHub Actions Waiting

rmaddikery force-pushed the rama_fix_docu branch from a93ffe4 to a2cfdcf Compare August 12, 2026 19:09

rmaddikery deployed to workflow-approval August 12, 2026 19:09 — with GitHub Actions Active

rmaddikery force-pushed the rama_fix_docu branch from a2cfdcf to 3f1b071 Compare August 13, 2026 07:12

rmaddikery requested a deployment to workflow-approval August 13, 2026 07:12 — with GitHub Actions Waiting

rmaddikery force-pushed the rama_fix_docu branch from 3f1b071 to 1a54b8b Compare August 13, 2026 07:16

rmaddikery deployed to workflow-approval August 13, 2026 07:16 — with GitHub Actions Active

rmaddikery force-pushed the rama_fix_docu branch from 1a54b8b to 2796b1d Compare August 13, 2026 09:10

rmaddikery requested a deployment to workflow-approval August 13, 2026 09:10 — with GitHub Actions Waiting

rmaddikery force-pushed the rama_fix_docu branch from 2796b1d to 33c8772 Compare August 13, 2026 09:38

rmaddikery requested a deployment to workflow-approval August 13, 2026 09:38 — with GitHub Actions Waiting

rmaddikery deployed to workflow-approval August 13, 2026 10:15 — with GitHub Actions Active

rmaddikery moved this from Backlog to In Progress in LOG - Logging FT Aug 13, 2026

rmaddikery force-pushed the rama_fix_docu branch from 3ce7854 to ec6433c Compare August 13, 2026 10:23

rmaddikery requested a deployment to workflow-approval August 13, 2026 10:23 — with GitHub Actions Waiting

rmaddikery force-pushed the rama_fix_docu branch from ec6433c to db2c377 Compare August 13, 2026 10:27

rmaddikery deployed to workflow-approval August 13, 2026 10:27 — with GitHub Actions Active

rmaddikery marked this pull request as ready for review August 13, 2026 10:50

rmaddikery force-pushed the rama_fix_docu branch from db2c377 to 2092f73 Compare August 13, 2026 10:55

rmaddikery deployed to workflow-approval August 13, 2026 10:55 — with GitHub Actions Active

rmaddikery force-pushed the rama_fix_docu branch from 2092f73 to 6af93d4 Compare August 14, 2026 06:55

rmaddikery deployed to workflow-approval August 14, 2026 06:55 — with GitHub Actions Active

arsibo reviewed Aug 14, 2026

View reviewed changes

rmaddikery force-pushed the rama_fix_docu branch from 6af93d4 to 846aa81 Compare August 14, 2026 12:01

rmaddikery deployed to workflow-approval August 14, 2026 12:01 — with GitHub Actions Active

pawelrutkaq reviewed Aug 14, 2026

View reviewed changes

rmaddikery force-pushed the rama_fix_docu branch from 846aa81 to 5bcf0bf Compare August 14, 2026 12:08

rmaddikery requested a deployment to workflow-approval August 14, 2026 12:08 — with GitHub Actions Waiting

rmaddikery force-pushed the rama_fix_docu branch from 5bcf0bf to 27baea8 Compare August 14, 2026 12:12

rmaddikery deployed to workflow-approval August 14, 2026 12:12 — with GitHub Actions Active

rmaddikery added 5 commits August 14, 2026 13:09

Fix top-level documentation

ab2a372

- Adds high-level overview of the mw::log decomposition - Remove outdated documentation - Restructure documentation to where it fits

Adds a section for the rust log bridge

04373c0

Links datarouter documentation to top-level docs

a5f3bf5

- Fixes .puml rendering

Fix top-level README.md

9f04a79

- Replace duplicated content with redirection to single source that resides next to source code rendered by Sphinx

Fix review comments

2ddff51

- Reflect score folder structure guideline - Adds high level architecture documentation and references related diagrams

rmaddikery force-pushed the rama_fix_docu branch from 27baea8 to 2ddff51 Compare August 14, 2026 13:09

rmaddikery deployed to workflow-approval August 14, 2026 13:09 — with GitHub Actions Active

arsibo reviewed Aug 14, 2026

View reviewed changes

		@@ -50,9 +50,9 @@ The following constraints influenced the logging infrastructure design:
		## Context

		@@ -35,84 +30,55 @@ It provides a standardized project structure, ensuring best practices for:
		### 1️⃣ Clone the Repository

Uh oh!

Conversation

rmaddikery commented Aug 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Aug 12, 2026

Uh oh!

arsibo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmaddikery Aug 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmaddikery commented Aug 12, 2026 •

edited

Loading

github-actions Bot commented Aug 12, 2026 •

edited

Loading

rmaddikery Aug 14, 2026 •

edited

Loading