Skip to content

Commit bc3bd0e

Browse files
committed
page restructuring
1 parent d1129bf commit bc3bd0e

26 files changed

Lines changed: 3191 additions & 60 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`.

0 commit comments

Comments
 (0)