Improve onboarding documentation by antonkri · Pull Request #2874 · eclipse-score/score

antonkri · 2026-05-06T08:22:21Z

No description provided.

github-actions · 2026-05-06T08:22:39Z

⚠️ Docs-as-Code version mismatch detected
Please check the CI build logs for details and align the documentation version with the Bazel dependency.

masc2023 · 2026-05-06T08:25:17Z

masc2023 · 2026-05-06T08:25:23Z

masc2023 · 2026-05-06T08:26:34Z

github-actions · 2026-05-06T08:36:10Z

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

PandaeDo

Some small comments from my side. Improvement of the onboarding is very helpful!

PandaeDo · 2026-05-06T12:44:18Z

+ * *******************************************************************************
+ *
+ * Overrides the default purple S-CORE secondary color (#2D1942).
+ * --pst-color-secondary is used for the page header, card headers, table hover, etc.


I don't know where. But it seems to me that the handbook is not correctly integrated into the page. I have a purple line in between Eclipse S-CORE and Features. Also under that after the home symbol i have . And the only way to reach the slides is the navigation on the right sight. Maybe only rendered wrong on my side. So please check it.

Same here, can not see any more entry point for handbook

PandaeDo · 2026-05-06T12:52:21Z

      ^^^
-      Our release roadmap can be found under :ref:`releases`.
-      Including an overview about integrated software modules and their repository location.
+      Check out our `latest release <https://eclipse-score.github.io/reference_integration/main/_collections/score_platform/docs/score_releases/score_releases/score_v0_6.html>`_


If you use this link it will allways have the latest version on top https://github.com/eclipse-score/reference_integration/releases. Or if you want to show the html format https://eclipse-score.github.io/reference_integration/main/.

PandaeDo · 2026-05-06T12:55:16Z

+and without direct customer value — S-CORE provides a common foundation with:
+
+- **A reference implementation** that catches integration issues early and prevents known bugs from reappearing across projects.
+- **A Functional-Safety-compliant process** (ISO 26262) applied to all modules, making S-CORE unique among open-source automotive projects.


I think it's not 100% when we say it will be applied to all modules. You might change it in a way that S-CORE includes a process based on ISO 26262 SEooC approach that is "ready the be certifiable" and it will applied by all modules that will contain in 1.0 release.

masc2023

Overview is still missing in the Start/Landing Page, only available as card, but not top level entry

masc2023 · 2026-05-11T04:18:44Z

System verification -> Platform or SW Platform Verification

OliverHeilwagen · 2026-05-11T09:24:48Z

Thanks a lot for the overview.
I would suggest the following improvements:

Unit Verification

Please add Rust Test as an alternative

Component / Feature Verification

Please add GoogleTest and Rust Test as an alternative.
In case the component is a library this should be sufficient for most test cases. For non-functional tests and later security tests ITF will probably get mandatory

Feature Verification

Please remove (ITF) from blue box.

FScholPer · 2026-05-11T11:57:27Z

+    --pst-color-text-base: #ffffff;
+    --pst-color-link: #ffffff;
+    --pst-color-link-hover: #ffffff;
+    color: #ffffff !important;


!important is bad practise as it destroys the layout

anmittag · 2026-05-18T06:19:37Z

-.. toctree::
-   :maxdepth: 1
-   :glob:
-
 Please note that the Eclipse S-CORE´s software architecture is continuously refined and will evolve in future releases.

 .. image:: ../../modules/_assets/module_architecture.drawio.svg


we have different mismatching architectural views: https://eclipse-score.github.io/score/pr-2874/_images/architecture_0_6.drawio.svg and the used link https://eclipse-score.github.io/score/pr-2874/_images/module_architecture.drawio.svg

a) we have to consolidate
b) for the purpose here, I would suggest to use the building block architectural view as in https://eclipse-score.github.io/score/pr-2874/_images/architecture_0_6.drawio.svg

anmittag · 2026-05-18T06:22:23Z

+html body .score-grid .sd-card .sd-card-body a:hover,
+html body .score-grid .sd-card .sd-card-body a:visited,
+html body .score-grid .sd-card .sd-card-body * {
+    color: #ffffff !important;


layout rules shall not be overwritten

anmittag · 2026-05-18T06:25:24Z

only cpp covered?
approval comments help, but 2nd source to process description: double maintenance issue!

anmittag · 2026-05-18T06:29:06Z

do we really follow the module=one repository approach?

anmittag · 2026-05-18T06:31:04Z

@@ -169,13 +173,14 @@ Here, we´re making the first declaration of our module by defining a name and a
 Please be aware, that only after our module was published in the Eclipse S-CORE bazel registry, other modules can access it.

 Rename the module and replace *cpp_rust_template_repository* by *score_scrample*.


score/<module_name instead scrample ?

AlexanderLanin · 2026-05-18T06:44:30Z

 ..
   # *******************************************************************************
-   # Copyright (c) 2024 Contributors to the Eclipse Foundation
+   # Copyright (c) 2026 Contributors to the Eclipse Foundation


do not replace copyright year in existing files. The year shall represent file creation (or last full rewrite)

AlexanderLanin · 2026-05-18T06:46:46Z

+
+
+def setup(app):
+    app.add_css_file("css/score.css", priority=600)


Introducing a new style file means we need someone to maintain it, as new docs-as-code versions can easily be incompatible. score repo is notoriously unmaintained.

masc2023

My comments resolved

Due to unavailibility

antonkri requested review from AlexanderLanin, MaximilianSoerenPollak, PandaeDo, aschemmel-tech, dcalavrezo-qorix, masc2023 and pahmann as code owners May 6, 2026 08:22

github-project-automation Bot added this to S-CORE Roadmap May 6, 2026

github-project-automation Bot moved this to Backlog in S-CORE Roadmap May 6, 2026

antonkri added the experimental-do-not-merge label May 6, 2026

masc2023 reviewed May 6, 2026

View reviewed changes

antonkri force-pushed the ankr_improve_onboarding_doc branch from f3d1407 to c0ddd6e Compare May 6, 2026 08:32

antonkri force-pushed the ankr_improve_onboarding_doc branch from c0ddd6e to 854c668 Compare May 6, 2026 11:51

PandaeDo reviewed May 6, 2026

View reviewed changes

antonkri force-pushed the ankr_improve_onboarding_doc branch 3 times, most recently from 00bf575 to 4485970 Compare May 10, 2026 15:31

antonkri requested review from a team, FScholPer, HartmannNico, grandyholger, johannes-esr, qor-lb, skappel29 and thilo-schmitt as code owners May 10, 2026 15:55

antonkri force-pushed the ankr_improve_onboarding_doc branch from 9c0d235 to 82bc924 Compare May 10, 2026 19:09

masc2023 requested changes May 11, 2026

View reviewed changes

OliverHeilwagen reviewed May 11, 2026

View reviewed changes

FScholPer reviewed May 11, 2026

View reviewed changes

antonkri dismissed RolandJentschETAS’s stale review via 8ebc22d May 11, 2026 16:02

antonkri force-pushed the ankr_improve_onboarding_doc branch 4 times, most recently from a2d81ae to 3ddd051 Compare May 15, 2026 08:17

anmittag previously requested changes May 18, 2026

View reviewed changes

AlexanderLanin reviewed May 18, 2026

View reviewed changes

antonkri force-pushed the ankr_improve_onboarding_doc branch 8 times, most recently from 2438e90 to 6e8863b Compare May 21, 2026 16:54

antonkri changed the title ~~WIP: improve onboarding documentation~~ Improve onboarding documentation May 24, 2026

github-project-automation Bot added this to TLC - Technical Lead Circle May 24, 2026

antonkri removed the experimental-do-not-merge label May 24, 2026

antonkri force-pushed the ankr_improve_onboarding_doc branch from 6e8863b to d1837e4 Compare May 24, 2026 08:53

Improve onboarding documentation

6035679

antonkri force-pushed the ankr_improve_onboarding_doc branch from d1837e4 to 6035679 Compare May 25, 2026 09:40

masc2023 approved these changes May 26, 2026

View reviewed changes

dcalavrezo-qorix approved these changes May 26, 2026

View reviewed changes

antonkri merged commit a2a757a into main May 26, 2026
8 checks passed

antonkri deleted the ankr_improve_onboarding_doc branch May 26, 2026 08:07

github-project-automation Bot moved this to Done in TLC - Technical Lead Circle May 26, 2026

github-project-automation Bot moved this from Backlog to Done in S-CORE Roadmap May 26, 2026

		@@ -169,13 +173,14 @@ Here, we´re making the first declaration of our module by defining a name and a
		Please be aware, that only after our module was published in the Eclipse S-CORE bazel registry, other modules can access it.

		Rename the module and replace cpp_rust_template_repository by score_scrample.



		def setup(app):
		app.add_css_file("css/score.css", priority=600)

Conversation

antonkri commented May 6, 2026

Uh oh!

github-actions Bot commented May 6, 2026

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!

github-actions Bot commented May 6, 2026

Uh oh!

PandaeDo 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!

Choose a reason for hiding this comment

Uh oh!

masc2023 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!

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!

masc2023 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants