Skip to content

Commit c3a9b38

Browse files
antonkriantonkri
committed
page restructuring
1 parent d1129bf commit c3a9b38

25 files changed

Lines changed: 2360 additions & 63 deletions

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

Lines changed: 67 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
---
2-
name: module-phase-tracker
3-
description: "Update the Feature and Process Status table in feature_and_process_status.rst. Use when: checking module status, updating feature status tracker, refreshing work product status, deriving completion status from eclipse-score GitHub repos for Baselibs, Communication, Logging, Orchestrator, Persistency, Time, Config Management, Lifecycle, Security/Crypto."
2+
name: overall-status
3+
description: "Update the Feature and Process Status table in docs/s_core_v_1/roadmap/overall_status.rst. Use when: checking module status, updating feature status tracker, refreshing work product status, deriving completion status from eclipse-score GitHub repos for Baselibs, Communication, Logging, Orchestrator, Persistency, Time, Config Management, Lifecycle, Security/Crypto."
44
argument-hint: "optional: module name or 'all'"
55
---
66

77
# Feature and Process Status Tracker
88

99
Derives and updates the completion status table in
10-
`docs/feature_and_process_status.rst` by querying the live eclipse-score GitHub
10+
`docs/s_core_v_1/roadmap/overall_status.rst` by querying the live eclipse-score GitHub
1111
repositories.
1212

13+
> **Navigation (updated 2026-05)**: `overall_status.rst` is linked from
14+
> `docs/s_core_v_1/roadmap/roadmap.rst` under the **Status & Goals** toctree section.
15+
> The file was moved from `docs/s_core_v_1/status/` to `docs/s_core_v_1/roadmap/`.
16+
> The `status/` folder has been removed. The roadmap itself is split into sub-pages:
17+
> `roadmap.rst`, `pi1.rst` – `pi4.rst`, `overall_status.rst`, all under `docs/s_core_v_1/roadmap/`.
18+
1319
## When to Use
1420

1521
- Refresh the tracker table with current data
@@ -18,7 +24,7 @@ repositories.
1824

1925
## RST File Structure
2026

21-
`docs/feature_and_process_status.rst` consists of a file header followed by 5
27+
`docs/s_core_v_1/roadmap/overall_status.rst` consists of a file header followed by 5
2228
Process Area sections. Each section has this exact pattern:
2329

2430
```rst
@@ -87,6 +93,7 @@ See :ref:`<workflow_ref>`.
8793
**Important rules:**
8894
- `.. needpie::` does **NOT** support a `:title:` option — omit it entirely (causes build errors)
8995
- The pie chart table uses CSS class `compact-overview-table`; each cell needs `.. rst-class:: small-pie-cell` before its `.. needpie::`
96+
- **Pie chart sizing**: `custom.css` sets `compact-overview-table` to `width: 100%; table-layout: fixed` with each column at `width: 33%`. The generated `<img>` elements have their sphinx-needs fixed pixel sizes overridden via `width: 100% !important; max-width: 100% !important; height: auto !important` (selectors: `.small-pie-cell img`, `.compact-overview-table td img`, `img[id^="needpie-"]`). **Do NOT add explicit pixel sizes** — this causes horizontal scrolling.
9097
- The module tracker table uses CSS class `module-phase-tracker-table`
9198
- Both `.. rubric::` directives are plain inline text — NOT RST section headings
9299
- The `.. rubric:: Implementation status:` line is computed (see Step 4 in Procedure) and placed directly before the module tracker table
@@ -99,8 +106,9 @@ See :ref:`<workflow_ref>`.
99106
| (4,663 tests)
100107
```
101108
```rst
102-
- 🔄 **C0:** 92.3%
109+
- 🔄
103110
111+
| **C0:** 92.3%
104112
| **C1:** 60.3% (cpp)
105113
| **Rust line:** 74.4%
106114
```
@@ -261,7 +269,7 @@ See :ref:`verification_workflows`.
261269
**Dynamic Code Analysis** is tracked via sanitizer CI workflows ...
262270
```
263271

264-
Columns: **Unit Tests**, **C0/C1 Coverage**, **Comp. Integration Tests**, **Feature Integration Tests**, **Static Code Analysis**, **Dynamic Code Analysis**, **Module Verification Report**
272+
Columns: **Unit Tests**, **C0/C1 Coverage**, **Comp. Integration Tests**, **Feature Integration Tests**, **Static Code Analysis**, **Dynamic Code Analysis**, **Module Verification Report**, **Platform Verification Report**
265273

266274
**Cross-module integration test format** (when tests live in `reference_integration`, not the module's own repo):
267275
```rst
@@ -353,18 +361,20 @@ gh api "repos/eclipse-score/reference_integration/actions/jobs/$JOB_ID/logs" \
353361
| Lifecycle | `score_lifecycle_health_cpp` | `score_lifecycle_health_rust` |
354362
| Security/Crypto | not in CI | — |
355363

356-
**Format in table (C0 on first line, C1 and Rust each as `| ` line-blocks):**
364+
**Format in table (status emoji alone on first line, all coverage metrics as `| ` line-blocks below):**
357365
- CPP + Rust:
358366
```rst
359-
- 🔄 **C0:** 92.3%
367+
- 🔄
360368
369+
| **C0:** 92.3%
361370
| **C1:** 60.3% (cpp)
362371
| **Rust line:** 74.4%
363372
```
364373
- CPP only:
365374
```rst
366-
- 🔄 **C0:** 87.9%
375+
- 🔄
367376
377+
| **C0:** 87.9%
368378
| **C1:** 58.8% (cpp)
369379
```
370380
- Not available: `❌ Open`
@@ -455,6 +465,15 @@ Dynamic analysis is performed via sanitizer CI workflows (ASan/UBSan/LSan for C+
455465
- **🔄 In Progress**: file exists with `:status: draft`
456466
- **❌ Open**: file does not exist, OR file is a template placeholder only
457467

468+
### Process Area 5 — Platform Verification Report
469+
The Platform Verification Report (`wp__verification_platform_ver_report`) is a single cross-module document in `eclipse-score/score` at `docs/score_releases/verification/platform_ver_report.rst`. It tracks **feature requirement test coverage** (via `FullyVerifies`/`PartiallyVerifies` links in Feature Integration Tests on `feat_req__...` IDs) and platform-level test results.
470+
471+
- **✅ Available**: `docs/score_releases/verification/platform_ver_report.rst` has `:status: valid` AND contains actual verification data
472+
- **🔄 In Progress**: file exists with `:status: draft`
473+
- **❌ Open**: file does not exist, OR is a template placeholder only
474+
475+
> ⚠️ This column is **not per-module** — it is the same document for all modules. Show the same status in every row.
476+
458477
## Procedure
459478

460479
### Prerequisites
@@ -662,7 +681,7 @@ Before updating the file, verify these invariants:
662681

663682
### Step 6 — Update the RST file
664683

665-
Write the computed values to `docs/feature_and_process_status.rst` following the formatting rules in the RST File Structure section above. Update the `.. rubric:: Implementation status:` line for each PA.
684+
Write the computed values to `docs/s_core_v_1/roadmap/overall_status.rst` following the formatting rules in the RST File Structure section above. Update the `.. rubric:: Implementation status:` line for each PA.
666685

667686
---
668687

@@ -689,9 +708,45 @@ Add a row to the Modules and Repos table above (with known_good.json key and pat
689708
- Central CodeQL finding counts require GitHub Security tab access.
690709
- Feature integration tests heuristic is weak — manual verification recommended
691710

711+
## Docs Structure (reference_integration)
712+
713+
```
714+
docs/
715+
index.rst ← top-level: Modules, PMT, S-Core v1.0, Integration Status
716+
conf.py ← Sphinx config (pydata theme, sidebar-toggle.js, custom.css)
717+
_assets/
718+
custom.css ← compact-overview-table (fluid 33%-per-column pie charts, !important img override), module-phase-tracker-table, wide-content-page, collapsible right sidebar
719+
sidebar-toggle.js ← right sidebar collapse/expand toggle (persisted in localStorage)
720+
_templates/
721+
sidebar-root-nav.html ← left nav with startdepth=0 (shows full toctree on all pages)
722+
s_core_v_1/
723+
index.rst ← S-Core v1.0 section: Status, Releases, Verification, Roadmap
724+
status/
725+
status.rst ← Status section index (toctree)
726+
overall_status.rst ← Feature and Process Status tracker (THIS FILE — updated by this skill)
727+
releases/
728+
releases.rst
729+
score_07.rst
730+
verification/
731+
verification.rst
732+
unit_test_summary.md
733+
coverage_summary.md
734+
roadmap.rst
735+
integration_process/
736+
integration_process.rst ← Integration Process section (currently empty placeholder)
737+
sw_components.rst
738+
process_tools.rst
739+
needs_filters.py ← sphinx-needs filter functions for pie charts
740+
```
741+
742+
**`conf.py` key settings:**
743+
- `html_sidebars = {"**": ["sidebar-root-nav"]}` — full left nav on every page
744+
- `html_js_files = ["sidebar-toggle.js"]` — collapsible right TOC sidebar
745+
- `html_theme_options.secondary_sidebar_items` — suppresses right TOC on `s_core_v_1/roadmap/overall_status` and `feature_and_process_status` pages
746+
692747
## Complete RST Snapshot
693748

694-
Full content of `docs/feature_and_process_status.rst` as of last update (2026-05).
749+
Full content of `docs/s_core_v_1/roadmap/overall_status.rst` as of last update (2026-05).
695750
Use this to recreate the file from scratch if needed.
696751

697-
See the file directly at `docs/feature_and_process_status.rst` in `eclipse-score/reference_integration`.
752+
See the file directly at `docs/s_core_v_1/roadmap/overall_status.rst` in `eclipse-score/reference_integration`.

‎.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: 142 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,127 @@
6578
body.wide-content-page .bd-content .bd-article-container {
6679
max-width: 100%;
6780
}
81+
82+
/* ---------------------------------------------------------------------------
83+
* Collapsible right sidebar (page-TOC)
84+
* ---------------------------------------------------------------------------*/
85+
86+
#right-sidebar-toggle {
87+
position: absolute;
88+
top: 0.6rem;
89+
left: -1.4rem;
90+
z-index: 100;
91+
width: 1.4rem;
92+
height: 1.8rem;
93+
padding: 0;
94+
border: 1px solid var(--pst-color-border, #d0d0d0);
95+
border-right: none;
96+
border-radius: 4px 0 0 4px;
97+
background: var(--pst-color-background, #fff);
98+
color: var(--pst-color-text-muted, #666);
99+
font-size: 0.75rem;
100+
line-height: 1.8rem;
101+
cursor: pointer;
102+
transition: background 0.15s;
103+
}
104+
105+
#right-sidebar-toggle:hover {
106+
background: var(--pst-color-surface, #f5f5f5);
107+
}
108+
109+
.bd-sidebar-secondary {
110+
position: relative;
111+
transition: width 0.2s ease, min-width 0.2s ease, padding 0.2s ease,
112+
opacity 0.2s ease;
113+
}
114+
115+
.bd-sidebar-secondary.collapsed {
116+
width: 0 !important;
117+
min-width: 0 !important;
118+
padding-left: 0 !important;
119+
padding-right: 0 !important;
120+
overflow: visible;
121+
border: none;
122+
}
123+
124+
.bd-sidebar-secondary.collapsed > *:not(#right-sidebar-toggle) {
125+
opacity: 0;
126+
pointer-events: none;
127+
}
128+
129+
/* ---------------------------------------------------------------------------
130+
* Process-area cards (used in roadmap.rst — Qualifiable State section)
131+
* ---------------------------------------------------------------------------*/
132+
133+
.card-pa-grey {
134+
background-color: #e8e8e8 !important;
135+
border-color: #c8c8c8 !important;
136+
font-size: 0.82rem;
137+
}
138+
139+
.card-pa-grey .sd-card-header {
140+
background-color: #e8e8e8 !important;
141+
border-color: #c8c8c8 !important;
142+
font-size: 0.82rem;
143+
font-weight: 600;
144+
padding: 0.4rem 0.6rem;
145+
}
146+
147+
.card-pa-grey .sd-card-body {
148+
background-color: #e8e8e8 !important;
149+
color: #444;
150+
padding: 0.4rem 0.6rem;
151+
font-size: 0.78rem;
152+
}
153+
154+
/* Thin border around each process-area grid group (Management / Development / Support) */
155+
.score-grid {
156+
border: 1px solid #c0c8d4;
157+
border-radius: 6px;
158+
padding: 0.6rem 0.6rem 0.2rem 0.6rem;
159+
margin-bottom: 1.2rem;
160+
}
161+
162+
/* Compact card grid (Management section) — approximately half the visual size */
163+
.score-grid-compact .sd-card {
164+
min-height: unset;
165+
}
166+
167+
.score-grid-compact .sd-card-header {
168+
padding: 0.2rem 0.35rem !important;
169+
font-size: 0.68rem !important;
170+
}
171+
172+
.score-grid-compact .sd-card-body {
173+
padding: 0.2rem 0.35rem !important;
174+
font-size: 0.62rem !important;
175+
}
176+
177+
/* Highlighted process-area cards (Requirements Engineering, Architecture Design,
178+
Implementation, Verification) */
179+
.card-pa-highlight {
180+
background-color: #1a5fa8 !important;
181+
border-color: #134a87 !important;
182+
font-size: 0.82rem;
183+
}
184+
185+
.card-pa-highlight .sd-card-header {
186+
background-color: #1a5fa8 !important;
187+
border-color: #134a87 !important;
188+
font-size: 0.82rem;
189+
font-weight: 600;
190+
padding: 0.4rem 0.6rem;
191+
color: #ffffff !important;
192+
}
193+
194+
.card-pa-highlight .sd-card-header a,
195+
.card-pa-highlight .sd-card-header a:visited {
196+
color: #ffffff !important;
197+
}
198+
199+
.card-pa-highlight .sd-card-body {
200+
background-color: #1a5fa8 !important;
201+
color: #e8f0fc !important;
202+
padding: 0.4rem 0.6rem;
203+
font-size: 0.78rem;
204+
}

0 commit comments

Comments
 (0)