Skip to content

WIP: improve onboarding documentation#2874

Open
antonkri wants to merge 3 commits into
mainfrom
ankr_improve_onboarding_doc
Open

WIP: improve onboarding documentation#2874
antonkri wants to merge 3 commits into
mainfrom
ankr_improve_onboarding_doc

Conversation

@antonkri
Copy link
Copy Markdown
Contributor

@antonkri antonkri commented May 6, 2026

No description provided.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

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

masc2023
masc2023 reviewed May 6, 2026
View reviewed changes
Comment thread docs/_assets/css/score_handbook.css
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright 2026?

Comment thread docs/_assets/js/toc_collapse.js Outdated
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright 2026?

Comment thread docs/handbook/whats_next/index.rst
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright 2026?

@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch from f3d1407 to c0ddd6e Compare May 6, 2026 08:32
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

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

@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch from c0ddd6e to 854c668 Compare May 6, 2026 11:51
PandaeDo
PandaeDo reviewed May 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@PandaeDo PandaeDo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/_assets/css/score_handbook.css Outdated
* *******************************************************************************
*
* Overrides the default purple S-CORE secondary color (#2D1942).
* --pst-color-secondary is used for the page header, card headers, table hover, etc.
Copy link
Copy Markdown
Contributor

@PandaeDo PandaeDo May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@masc2023 masc2023 May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/index.rst
^^^
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>`_
Copy link
Copy Markdown
Contributor

@PandaeDo PandaeDo May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/.

Comment thread docs/index.rst Outdated
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.
Copy link
Copy Markdown
Contributor

@PandaeDo PandaeDo May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch 2 times, most recently from 20e92be to 00bf575 Compare May 10, 2026 15:26
@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch from 00bf575 to 4485970 Compare May 10, 2026 15:31
@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch from 9c0d235 to 82bc924 Compare May 10, 2026 19:09
masc2023
masc2023 requested changes May 11, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/handbook/_assets/score_tooling.drawio.svg
Copy link
Copy Markdown
Contributor

@masc2023 masc2023 May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

System verification -> Platform or SW Platform Verification

OliverHeilwagen
OliverHeilwagen reviewed May 11, 2026
View reviewed changes
Comment thread docs/handbook/_assets/score_tooling.drawio.svg
Copy link
Copy Markdown
Contributor

@OliverHeilwagen OliverHeilwagen May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

RolandJentschETAS
RolandJentschETAS requested changes May 11, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@RolandJentschETAS RolandJentschETAS left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The information is great ..

@RolandJentschETAS RolandJentschETAS self-requested a review May 11, 2026 11:54
@RolandJentschETAS RolandJentschETAS self-requested a review May 11, 2026 11:54
FScholPer
FScholPer reviewed May 11, 2026
View reviewed changes
Comment thread docs/_assets/css/score.css
--pst-color-text-base: #ffffff;
--pst-color-link: #ffffff;
--pst-color-link-hover: #ffffff;
color: #ffffff !important;
Copy link
Copy Markdown
Contributor

@FScholPer FScholPer May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

!important is bad practise as it destroys the layout

@antonkri antonkri force-pushed the ankr_improve_onboarding_doc branch from 82bc924 to 8ebc22d Compare May 11, 2026 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@FScholPer FScholPer FScholPer left review comments

@PandaeDo PandaeDo PandaeDo left review comments

@masc2023 masc2023 masc2023 requested changes

@AlexanderLanin AlexanderLanin Awaiting requested review from AlexanderLanin AlexanderLanin is a code owner

@dcalavrezo-qorix dcalavrezo-qorix Awaiting requested review from dcalavrezo-qorix dcalavrezo-qorix is a code owner

@MaximilianSoerenPollak MaximilianSoerenPollak Awaiting requested review from MaximilianSoerenPollak MaximilianSoerenPollak is a code owner

@pahmann pahmann Awaiting requested review from pahmann pahmann is a code owner

@aschemmel-tech aschemmel-tech Awaiting requested review from aschemmel-tech aschemmel-tech is a code owner

@thilo-schmitt thilo-schmitt Awaiting requested review from thilo-schmitt thilo-schmitt is a code owner

@HartmannNico HartmannNico Awaiting requested review from HartmannNico HartmannNico is a code owner

@skappel29 skappel29 Awaiting requested review from skappel29 skappel29 is a code owner

@grandyholger grandyholger Awaiting requested review from grandyholger grandyholger is a code owner

@qor-lb qor-lb Awaiting requested review from qor-lb qor-lb is a code owner

@johannes-esr johannes-esr Awaiting requested review from johannes-esr johannes-esr is a code owner

@RolandJentschETAS RolandJentschETAS Awaiting requested review from RolandJentschETAS

+1 more reviewer

@OliverHeilwagen OliverHeilwagen OliverHeilwagen left review comments

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

experimental-do-not-merge

Projects

S-CORE Roadmap
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@antonkri @RolandJentschETAS @OliverHeilwagen @masc2023 @FScholPer @PandaeDo