Skip to content

Commit 70aa15d

Browse files
antonkriantonkri
committed
page restructuring
1 parent d1129bf commit 70aa15d

26 files changed

Lines changed: 2571 additions & 106 deletions

.github/skills/module-phase-tracker/SKILL.md renamed to .github/skills/overall-status/SKILL.md

Lines changed: 243 additions & 15 deletions
Large diffs are not rendered by default.

‎.github/workflows/test_and_docs.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,16 @@ jobs:
7474
- name: Publish build summary
7575
if: always()
7676
run: |
77-
if [ -f docs/verification_report/unit_test_summary.md ]; then
78-
cat docs/verification_report/unit_test_summary.md >> "$GITHUB_STEP_SUMMARY"
77+
if [ -f docs/s_core_v_1/verification/unit_test_summary.md ]; then
78+
cat docs/s_core_v_1/verification/unit_test_summary.md >> "$GITHUB_STEP_SUMMARY"
7979
else
80-
echo "No build summary file found (docs/verification_report/unit_test_summary.md)" >> "$GITHUB_STEP_SUMMARY"
80+
echo "No build summary file found (docs/s_core_v_1/verification/unit_test_summary.md)" >> "$GITHUB_STEP_SUMMARY"
8181
fi
8282
echo "" >> "$GITHUB_STEP_SUMMARY" # Add a newline for better formatting
83-
if [ -f docs/verification_report/coverage_summary.md ]; then
84-
cat docs/verification_report/coverage_summary.md >> "$GITHUB_STEP_SUMMARY"
83+
if [ -f docs/s_core_v_1/verification/coverage_summary.md ]; then
84+
cat docs/s_core_v_1/verification/coverage_summary.md >> "$GITHUB_STEP_SUMMARY"
8585
else
86-
echo "No coverage summary file found (docs/verification_report/coverage_summary.md)" >> "$GITHUB_STEP_SUMMARY"
86+
echo "No coverage summary file found (docs/s_core_v_1/verification/coverage_summary.md)" >> "$GITHUB_STEP_SUMMARY"
8787
fi
8888
- name: Create archive of test reports
8989
if: github.ref_type == 'tag'

‎docs/_assets/custom.css‎

Lines changed: 95 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,29 @@
2929
vertical-align: middle;
3030
}
3131

32+
.compact-overview-table {
33+
width: 100%;
34+
table-layout: fixed;
35+
max-width: 100%;
36+
}
37+
38+
.compact-overview-table td {
39+
width: 33%;
40+
overflow: hidden;
41+
}
42+
3243
.compact-overview-table td:has(img[id^="needpie-"]) {
33-
min-width: 420px;
3444
vertical-align: middle;
3545
text-align: center;
3646
}
3747

38-
.compact-overview-table td:has(img[id^="needpie-"]) img {
39-
width: 420px;
40-
max-width: none;
41-
height: auto;
48+
/* Override the fixed pixel size sphinx-needs writes into the img attributes */
49+
.small-pie-cell img,
50+
.compact-overview-table td img,
51+
img[id^="needpie-"] {
52+
width: 100% !important;
53+
max-width: 100% !important;
54+
height: auto !important;
4255
display: block;
4356
margin: 0 auto;
4457
}
@@ -65,3 +78,80 @@
6578
body.wide-content-page .bd-content .bd-article-container {
6679
max-width: 100%;
6780
}
81+
82+
/* ---------------------------------------------------------------------------
83+
* Process-area cards (used in roadmap.rst — Qualifiable State section)
84+
* ---------------------------------------------------------------------------*/
85+
86+
.card-pa-grey {
87+
background-color: #e8e8e8 !important;
88+
border-color: #c8c8c8 !important;
89+
font-size: 0.82rem;
90+
}
91+
92+
.card-pa-grey .sd-card-header {
93+
background-color: #e8e8e8 !important;
94+
border-color: #c8c8c8 !important;
95+
font-size: 0.82rem;
96+
font-weight: 600;
97+
padding: 0.4rem 0.6rem;
98+
}
99+
100+
.card-pa-grey .sd-card-body {
101+
background-color: #e8e8e8 !important;
102+
color: #444;
103+
padding: 0.4rem 0.6rem;
104+
font-size: 0.78rem;
105+
}
106+
107+
/* Thin border around each process-area grid group (Management / Development / Support) */
108+
.score-grid {
109+
border: 1px solid #c0c8d4;
110+
border-radius: 6px;
111+
padding: 0.6rem 0.6rem 0.2rem 0.6rem;
112+
margin-bottom: 1.2rem;
113+
}
114+
115+
/* Compact card grid (Management section) — approximately half the visual size */
116+
.score-grid-compact .sd-card {
117+
min-height: unset;
118+
}
119+
120+
.score-grid-compact .sd-card-header {
121+
padding: 0.2rem 0.35rem !important;
122+
font-size: 0.68rem !important;
123+
}
124+
125+
.score-grid-compact .sd-card-body {
126+
padding: 0.2rem 0.35rem !important;
127+
font-size: 0.62rem !important;
128+
}
129+
130+
/* Highlighted process-area cards (Requirements Engineering, Architecture Design,
131+
Implementation, Verification) */
132+
.card-pa-highlight {
133+
background-color: #1a5fa8 !important;
134+
border-color: #134a87 !important;
135+
font-size: 0.82rem;
136+
}
137+
138+
.card-pa-highlight .sd-card-header {
139+
background-color: #1a5fa8 !important;
140+
border-color: #134a87 !important;
141+
font-size: 0.82rem;
142+
font-weight: 600;
143+
padding: 0.4rem 0.6rem;
144+
color: #ffffff !important;
145+
}
146+
147+
.card-pa-highlight .sd-card-header a,
148+
.card-pa-highlight .sd-card-header a:visited {
149+
color: #ffffff !important;
150+
}
151+
152+
.card-pa-highlight .sd-card-body {
153+
background-color: #1a5fa8 !important;
154+
color: #e8f0fc !important;
155+
padding: 0.4rem 0.6rem;
156+
font-size: 0.78rem;
157+
}

‎docs/_assets/pi_timeline_2026.drawio.svg‎

Lines changed: 299 additions & 0 deletions
Loading

‎docs/_assets/sw_arch_v_1.drawio.svg‎

Lines changed: 1253 additions & 0 deletions
Loading

‎docs/code_quality.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Code Quality
16+
============
17+
18+
.. toctree::
19+
:titlesonly:
20+
:maxdepth: 1
21+
22+
verification_report/platform_verification_report
23+
verification_report/coverage_summary
24+
verification_report/unit_test_summary

‎docs/conf.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,13 @@ def _patch_needpie_suppress_legend() -> None:
5555
html_static_path = ["_assets"]
5656
html_css_files = ["custom.css"]
5757

58-
# Theme options: suppress the right-side TOC sidebar on the status overview page
59-
# (it is very wide and the local nav is not useful there).
58+
6059
html_theme_options = {
6160
"secondary_sidebar_items": {
6261
"**": ["page-toc"],
6362
"feature_and_process_status": [],
63+
"s_core_v_1/roadmap/overall_status": [],
6464
},
65+
"show_toc_level": 2,
66+
"navigation_with_keys": False,
6567
}

‎docs/index.rst‎

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,47 +15,41 @@
1515
Reference Integration Documentation
1616
===================================
1717

18-
Newest Release Notes
19-
--------------------
18+
The **Reference Integration** is the central integration repository of the
19+
eclipse-score project. It combines all
20+
S-CORE software modules — including Communication, Logging, Orchestrator,
21+
Persistency, Time, Config Management, Lifecycle, and Security/Crypto — into a
22+
single, consistently versioned workspace.
2023

21-
:doc:`score_releases/release_note_score_07`
24+
Its purpose is to verify that all modules build, integrate, and pass their
25+
tests together, providing a stable baseline for downstream projects. The
26+
repository also hosts the consolidated documentation, verification reports,
27+
and release notes for each S-CORE release.
2228

23-
Current Integration Status Overview
24-
-----------------------------------
29+
.. grid:: 1 1 3 3
30+
:gutter: 3
2531

26-
`View dashboard (points always to main for now) <https://eclipse-score.github.io/reference_integration/main/status_dashboard.html>`_
32+
.. grid-item-card:: 📊 Status & Roadmap
33+
:link: status_roadmap
34+
:link-type: doc
2735

28-
Explore the documentation
29-
-------------------------
30-
.. toctree::
31-
:titlesonly:
32-
:maxdepth: 1
33-
34-
Modules <sw_components>
35-
PMT <process_tools>
36-
Release Notes <release_notes>
37-
Status <feature_and_process_status>
36+
Module status, :doc:`S-Core v1.0 Roadmap <s_core_v_1/roadmap/roadmap>`, PI planning, and integration status.
3837

38+
.. grid-item-card:: 📖 Process, Methods & Tools
39+
:link: process_methods_tools
40+
:link-type: doc
3941

40-
.. toctree::
41-
:caption: Process, Methods, and Tools
42-
:titlesonly:
43-
:maxdepth: 1
42+
S-CORE process description, platform standards, and documentation toolchain.
4443

45-
_collections/score_platform/docs/index
46-
_collections/score_process/process/index
47-
_collections/score_docs_as_code/docs/index
48-
49-
.. toctree::
50-
:caption: Code Quality
51-
:titlesonly:
52-
:glob:
44+
.. grid-item-card:: ✅ Code Quality
45+
:link: code_quality
46+
:link-type: doc
5347

54-
verification_report/platform_verification_report
48+
Platform verification report and test coverage results.
5549

5650
.. toctree::
5751
:hidden:
58-
:glob:
5952

60-
score_releases/*
61-
verification_report/*
53+
status_roadmap
54+
process_methods_tools
55+
code_quality

‎docs/integration_process/integration_process.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2026 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Integration Process
16+
###################

‎docs/needs_filters.py‎

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,7 @@ def std_req_status_for_area(needs, results, arg1=""):
3131
std_req_ids = set()
3232
needs_by_id = {n["id"]: n for n in needs}
3333
for need in needs:
34-
if (
35-
need.get("type") == "gd_req"
36-
and not need.get("is_external", False)
37-
and area_tag in need.get("tags", [])
38-
):
34+
if need.get("type") == "gd_req" and not need.get("is_external", False) and area_tag in need.get("tags", []):
3935
for ref_id in need.get("complies", []):
4036
if ref_id.startswith("std_req__iso26262__"):
4137
std_req_ids.add(ref_id)
@@ -83,10 +79,7 @@ def wp_tag_status(needs, results, arg1=""):
8379
tags = set(need.get("tags", []))
8480
if "done_automation" in tags:
8581
automated += 1
86-
elif any(
87-
t.startswith("prio_") and t.endswith("_automation")
88-
for t in tags
89-
):
82+
elif any(t.startswith("prio_") and t.endswith("_automation") for t in tags):
9083
waiting += 1
9184
elif any(t.startswith("manual_prio_") for t in tags):
9285
inspection += 1
@@ -112,18 +105,11 @@ def area_verification_status(needs, results, arg1=""):
112105
area_tag = arg1.strip()
113106
automated = waiting = inspection = other = 0
114107
for need in needs:
115-
if (
116-
need.get("type") == "gd_req"
117-
and not need.get("is_external", False)
118-
and area_tag in need.get("tags", [])
119-
):
108+
if need.get("type") == "gd_req" and not need.get("is_external", False) and area_tag in need.get("tags", []):
120109
tags = set(need.get("tags", []))
121110
if "done_automation" in tags:
122111
automated += 1
123-
elif any(
124-
t.startswith("prio_") and t.endswith("_automation")
125-
for t in tags
126-
):
112+
elif any(t.startswith("prio_") and t.endswith("_automation") for t in tags):
127113
waiting += 1
128114
elif any(t.startswith("manual_prio_") for t in tags):
129115
inspection += 1

0 commit comments

Comments
 (0)