Skip to content

WIP: improve onboarding documentation#2874

Open
antonkri wants to merge 1 commit intomainfrom
ankr_improve_onboarding_doc
Open

WIP: improve onboarding documentation#2874
antonkri wants to merge 1 commit intomainfrom
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

copyright 2026?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

copyright 2026?

Copy link
Copy Markdown
Contributor

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

* *******************************************************************************
*
* 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

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

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

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

3 participants