Skip to content

Commit 6692efd

Browse files
committed
docs: add missing pages to root toctree
Sphinx (warnings-as-errors) failed because docs/s_core_v_1/index.rst and docs/verification_report/platform_verification_report.rst were referenced via grid-cards but not listed in any toctree.
1 parent fb4d0a6 commit 6692efd

10 files changed

Lines changed: 66 additions & 88 deletions

File tree

.github/skills/overall-status/SKILL.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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."
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, Persistency, Time, Config Management, Lifecycle, Security/Crypto."
44
argument-hint: "optional: module name or 'all'"
55
---
66

@@ -151,6 +151,8 @@ The pie chart diagrams are computed live by sphinx-needs at build time — they
151151
152152
## Modules and Repos
153153
154+
> **EXCLUDED MODULES**: **Orchestrator** is intentionally not tracked in `overall_status.rst` and must NOT be added to any of the PA tables, even though `score_orchestrator` is pinned in `known_good.json` and the module exists in `eclipse-score/score` / `eclipse-score/orchestrator`. Do not query or generate rows for it.
155+
154156
> **IMPORTANT**: Each module has its own dedicated repo in the `eclipse-score` GitHub org AND content in `eclipse-score/score`. **Always check BOTH** the module's own repo and `eclipse-score/score` when counting needs elements. Never rely on `eclipse-score/score` alone.
155157
156158
> **VERSION PINNING**: Always use the commit hash pinned in `known_good.json` (column `known_good.json key`) — **never use `main`** for source repos. This ensures data matches exactly the versions that `reference_integration` is currently testing against. For modules not listed in `known_good.json` (marked `—`), fall back to `main`.
@@ -160,7 +162,6 @@ The pie chart diagrams are computed live by sphinx-needs at build time — they
160162
| Baselibs | `score_baselibs` | `eclipse-score/baselibs` (no sphinx-needs RST so far) | `docs/modules/baselibs/**`, `docs/features/baselibs/docs` |
161163
| Communication | `score_communication` | `eclipse-score/communication` (no sphinx-needs RST so far) | `docs/modules/communication/**`, `docs/features/communication/docs` |
162164
| Logging | `score_logging` | `eclipse-score/logging` (no sphinx-needs RST so far) | `docs/modules/logging/**`, `docs/features/analysis-infra/logging/docs` |
163-
| Orchestrator | `score_orchestrator` | `eclipse-score/orchestrator` | `docs/modules/orchestrator/**`, `docs/features/orchestration` |
164165
| Persistency | `score_persistency` | `eclipse-score/persistency` — has `docs/persistency/kvs/` with comp_req/comp_arc ✅ | `docs/features/persistency` |
165166
| Time | `—` (not in known_good) | `eclipse-score/inc_time` (no sphinx-needs RST so far) | `docs/features/time/docs` |
166167
| Config Management | `—` (not in known_good) | `eclipse-score/config_management` (no sphinx-needs RST so far) | `docs/features/configuration` |
@@ -197,7 +198,7 @@ for repo in ["eclipse-score/score", "eclipse-score/<module_own_repo>"]:
197198
- **✅ Available**: A closed GitHub Issue with "Feature Request" or "Contribution Request" for the module exists in `eclipse-score/score`
198199
- **❌ Open**: No such issue found
199200

200-
Known closed CRs: Baselibs (#549), Communication (#69), Logging (#68), Orchestrator (#273), Persistency (#95), Time (#910), Config Management (#754, #1764), Lifecycle (#909), Security/Crypto (#905)
201+
Known closed CRs: Baselibs (#549), Communication (#69), Logging (#68), Persistency (#95), Time (#910), Config Management (#754, #1764), Lifecycle (#909), Security/Crypto (#905)
201202

202203
### Process Area 2 — Feature Requirements
203204
- **✅ Available**: 100% of individual needs elements (e.g. `.. feat_req::`) inside the requirements doc have `:status: valid`
@@ -260,7 +261,7 @@ See :ref:`verification_workflows`.
260261
CI (``Code Quality & Documentation`` workflow, ``bazel coverage --config=ferrocene-coverage``).
261262
C0 = line coverage, C1 = branch coverage. Rust coverage reports line coverage only.
262263
Modules not yet integrated into the reference_integration CI (Time, Config Mgmt) or with
263-
disabled coverage extraction (Orchestrator) show ❌ Open.
264+
Modules not yet integrated into the reference_integration CI (Time, Config Mgmt) show ❌ Open.
264265
265266
.. note::
266267
@@ -379,7 +380,6 @@ gh api "repos/eclipse-score/reference_integration/actions/jobs/$JOB_ID/logs" \
379380
| Baselibs | `score_baselibs_cpp` | `score_baselibs_rust_rust` |
380381
| Communication | `score_communication_cpp` | — (disabled) |
381382
| Logging | `score_logging_cpp` | `score_logging_rust` |
382-
| Orchestrator | — (disabled) | — (disabled) |
383383
| Persistency | `score_persistency_cpp` | `score_persistency_rust` |
384384
| Time | not in CI ||
385385
| Config Mgmt | not in CI ||
@@ -459,7 +459,6 @@ Static analysis CI exists at two levels:
459459
| Baselibs | `✅ 0 findings` | [clang-tidy lint.yml](https://github.com/eclipse-score/baselibs/blob/main/.github/workflows/lint.yml) |
460460
| Communication | `🔄 Configured` | [static_analysis.bazelrc](https://github.com/eclipse-score/communication/blob/main/quality/static_analysis/static_analysis.bazelrc) + [CodeQL/MISRA](https://github.com/eclipse-score/communication/tree/main/quality/static_analysis) — no CI enforcement yet |
461461
| Logging | `❌ Open` ||
462-
| Orchestrator | `✅ 0 findings` | [Clippy clippy.yml](https://github.com/eclipse-score/orchestrator/blob/main/.github/workflows/clippy.yml) |
463462
| Persistency | `✅ 0 findings` | [Clippy clippy.yml](https://github.com/eclipse-score/persistency/blob/main/.github/workflows/clippy.yml) |
464463
| Time | `❌ Open` ||
465464
| Config Mgmt | `✅ 0 findings` | [clang-tidy static-analysis.yml](https://github.com/eclipse-score/config_management/blob/main/.github/workflows/static-analysis.yml) |
@@ -495,7 +494,6 @@ Dynamic analysis is performed via sanitizer CI workflows (ASan/UBSan/LSan for C+
495494
| Baselibs | `✅ 0 findings` | [sanitizers_linux.yml](https://github.com/eclipse-score/baselibs/blob/main/.github/workflows/sanitizers_linux.yml) — ASan+UBSan+LSan |
496495
| Communication | `✅ 0 findings` | [ASan/UBSan/LSan](https://github.com/eclipse-score/communication/blob/main/.github/workflows/address_undefined_behavior_leak_sanitizer.yml), [TSan](https://github.com/eclipse-score/communication/blob/main/.github/workflows/thread_sanitizer.yml) |
497496
| Logging | `❌ Open` ||
498-
| Orchestrator | `❌ Open` ||
499497
| Persistency | `❌ Open` ||
500498
| Time | `❌ Open` ||
501499
| Config Mgmt | `❌ Open` ||
@@ -560,7 +558,6 @@ REFS = {
560558
"baselibs": pinned_ref("score_baselibs"),
561559
"communication": pinned_ref("score_communication"),
562560
"logging": pinned_ref("score_logging"),
563-
"orchestrator": pinned_ref("score_orchestrator"),
564561
"persistency": pinned_ref("score_persistency"),
565562
"lifecycle": pinned_ref("score_lifecycle_health"),
566563
"inc_time": "main", # not in known_good
@@ -597,7 +594,6 @@ tree_score = get_tree("eclipse-score/score", REFS["score"])
597594
tree_baselibs = get_tree("eclipse-score/baselibs", REFS["baselibs"])
598595
tree_comm = get_tree("eclipse-score/communication", REFS["communication"])
599596
tree_log = get_tree("eclipse-score/logging", REFS["logging"])
600-
tree_orch = get_tree("eclipse-score/orchestrator", REFS["orchestrator"])
601597
tree_pers = get_tree("eclipse-score/persistency", REFS["persistency"])
602598
tree_life = get_tree("eclipse-score/lifecycle", REFS["lifecycle"])
603599
tree_time = get_tree("eclipse-score/inc_time", REFS["inc_time"])
@@ -694,9 +690,6 @@ Use these exact filters when calling `count_files()`. Verify printed file counts
694690
| Baselibs | Comp. Arch | score | `lambda p: 'modules/baselibs' in p and 'architecture' in p and p.endswith('.rst') and 'chklst' not in p` |
695691
| Baselibs | Arch. Inspection | score | `lambda p: 'baselibs' in p and 'chklst_arc_inspection' in p` |
696692
| Baselibs | Impl. Inspection | score | `lambda p: 'baselibs' in p and 'chklst_impl_inspection' in p` |
697-
| Orchestrator | Feat. Req | score | `lambda p: 'features/orchestration' in p and 'requirements' in p and p.endswith('.rst')` |
698-
| Orchestrator | Comp. Req | score | `lambda p: 'modules/orchestrator' in p and 'requirements' in p and p.endswith('.rst') and 'chklst' not in p` |
699-
| Orchestrator | Comp. Arch | score | `lambda p: 'modules/orchestrator' in p and 'architecture' in p and p.endswith('.rst') and 'chklst' not in p` |
700693
| Persistency | Feat. Req | score | `lambda p: 'features/persistency' in p and 'requirements' in p and p.endswith('.rst') and 'chklst' not in p` |
701694
| Persistency | Feat. Arch | score | `lambda p: 'features/persistency' in p and 'architecture' in p and p.endswith('.rst') and 'chklst' not in p` |
702695
| Persistency | Comp. Req | pers | `lambda p: 'kvs' in p and 'requirements' in p and p.endswith('.rst') and 'chklst' not in p` |

docs/_assets/custom.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,14 @@ body.wide-content-page .bd-content .bd-article-container {
155155
padding: 0.4rem 0.6rem;
156156
font-size: 0.78rem;
157157
}
158+
159+
/* ---------------------------------------------------------------------------
160+
* Landing-page grid cards (docs/index.rst): white text, original background.
161+
* ---------------------------------------------------------------------------*/
162+
163+
.landing-grid .sd-card *,
164+
.landing-grid .sd-card a,
165+
.landing-grid .sd-card a:visited,
166+
.landing-grid .sd-card a:hover {
167+
color: #ffffff !important;
168+
}

docs/_assets/pi_timeline_2026.drawio.svg

Lines changed: 6 additions & 6 deletions
Loading

docs/index.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ documentation set that downstream product distributions can build on.
3434

3535
.. grid:: 1 1 3 3
3636
:gutter: 3
37+
:class-container: landing-grid
3738

3839
.. grid-item-card:: 📊 Status & Roadmap
39-
:link: s_core_v_1/index
40+
:link: s_core_v_1/roadmap/roadmap
4041
:link-type: doc
4142

4243
:doc:`S-Core v1.0 Roadmap <s_core_v_1/roadmap/roadmap>` and PI planning.
@@ -73,7 +74,10 @@ documentation set that downstream product distributions can build on.
7374
.. toctree::
7475
:hidden:
7576

76-
sw_components
77-
integration_process/integration_process
78-
process_methods_tools
79-
s_core_v_1/releases/releases
77+
Modules <sw_components>
78+
Integration Process <integration_process/integration_process>
79+
Integration Status <https://eclipse-score.github.io/reference_integration/main/status_dashboard.html>
80+
Process & Tools <process_methods_tools>
81+
S-Core v1.0 <s_core_v_1/index>
82+
Releases <s_core_v_1/releases/releases>
83+
Verification Report <verification_report/platform_verification_report>

docs/s_core_v_1/roadmap/overall_status.rst

Lines changed: 7 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ See :ref:`chm_change_workflows`.
109109
:colors: LimeGreen, Gold, LightBlue, LightGray
110110
:filter-func: needs_filters.area_verification_status(change_management)
111111

112-
.. rubric:: Implementation status: 🔄 92% (11/12 deliverables complete)
112+
.. rubric:: Implementation status: 🔄 91% (10/11 deliverables complete)
113113

114114
.. list-table::
115115
:header-rows: 1
@@ -128,9 +128,6 @@ See :ref:`chm_change_workflows`.
128128
* - Logging
129129
- ✅ Available
130130

131-
* - Orchestrator
132-
- ✅ Available
133-
134131
* - Persistency
135132
- ✅ Available
136133

@@ -202,7 +199,7 @@ See :ref:`requirements_workflows`.
202199
:colors: LimeGreen, Gold, LightBlue, LightGray
203200
:filter-func: needs_filters.area_verification_status(requirements_engineering)
204201

205-
.. rubric:: Implementation status: 🔄 25% (9/36 deliverables complete)
202+
.. rubric:: Implementation status: 🔄 27% (9/33 deliverables complete)
206203

207204
.. list-table::
208205
:header-rows: 1
@@ -240,14 +237,6 @@ See :ref:`requirements_workflows`.
240237
- ❌ Open
241238
- ❌ Open
242239

243-
* - Orchestrator
244-
- 🔄 83% (26/31)
245-
- 🔄 0% (0/2)
246-
- 🔄 0% (0/2)
247-
248-
| `executor <https://github.com/eclipse-score/score/blob/main/docs/modules/orchestrator/executor/docs/requirements/chklst_req_inspection.rst>`__
249-
| `orchestrator <https://github.com/eclipse-score/score/blob/main/docs/modules/orchestrator/orchestrator/docs/requirements/chklst_req_inspection.rst>`__
250-
251240
* - Persistency
252241
- ✅ Available (41/41)
253242
- 🔄 94% (36/38)
@@ -351,7 +340,7 @@ See :ref:`arch_workflow`.
351340
:colors: LimeGreen, Gold, LightBlue, LightGray
352341
:filter-func: needs_filters.area_verification_status(architecture_design)
353342

354-
.. rubric:: Implementation status: 🔄 17% (6/36 deliverables complete)
343+
.. rubric:: Implementation status: 🔄 15% (5/33 deliverables complete)
355344

356345
.. list-table::
357346
:header-rows: 1
@@ -389,14 +378,6 @@ See :ref:`arch_workflow`.
389378
- ✅ Available (3/3)
390379
- ❌ Open
391380

392-
* - Orchestrator
393-
- 🔄 66% (4/6)
394-
- ✅ Available (27/27)
395-
- 🔄 0% (0/2)
396-
397-
| `executor <https://github.com/eclipse-score/score/blob/main/docs/modules/orchestrator/executor/docs/architecture/chklst_arc_inspection.rst>`__
398-
| `orchestrator <https://github.com/eclipse-score/score/blob/main/docs/modules/orchestrator/orchestrator/docs/architecture/chklst_arc_inspection.rst>`__
399-
400381
* - Persistency
401382
- ✅ Available (12/12)
402383
- 🔄 25% (1/4)
@@ -487,7 +468,7 @@ See :ref:`workflow_implementation`.
487468
:colors: LimeGreen, Gold, LightBlue, LightGray
488469
:filter-func: needs_filters.area_verification_status(implementation)
489470

490-
.. rubric:: Implementation status: 🔄 38% (18/48 deliverables complete)
471+
.. rubric:: Implementation status: 🔄 36% (16/44 deliverables complete)
491472

492473
.. list-table::
493474
:header-rows: 1
@@ -528,12 +509,6 @@ See :ref:`workflow_implementation`.
528509
- ❌ Open
529510
- ❌ Open
530511

531-
* - Orchestrator
532-
- ✅ Available
533-
- ✅ Available (~38,300 LOC) `orchestrator <https://github.com/eclipse-score/orchestrator>`__
534-
- ❌ Open
535-
- ❌ Open
536-
537512
* - Persistency
538513
- ✅ Available
539514
- ✅ Available (~8,700 LOC) `persistency <https://github.com/eclipse-score/persistency>`__
@@ -636,8 +611,8 @@ See :ref:`verification_workflows`.
636611
**C0/C1 Coverage** data is sourced from the `reference_integration <https://github.com/eclipse-score/reference_integration>`__
637612
CI (``Code Quality & Documentation`` workflow, ``bazel coverage --config=ferrocene-coverage``).
638613
C0 = line coverage, C1 = branch coverage. Rust coverage reports line coverage only.
639-
Modules not yet integrated into the reference_integration CI (Time, Config Mgmt) or with
640-
disabled coverage extraction (Orchestrator) show ❌ Open.
614+
Modules not yet integrated into the reference_integration CI (Time, Config Mgmt)
615+
show ❌ Open.
641616

642617
.. note::
643618

@@ -652,7 +627,7 @@ See :ref:`verification_workflows`.
652627
``--config=asan_ubsan_lsan``, TSan via ``--config=tsan``). All listed workflows are
653628
zero-tolerance, so a passing ``main`` branch implies **0 sanitizer findings**.
654629

655-
.. rubric:: Implementation status: 🔄 29% (25/87 deliverables complete)
630+
.. rubric:: Implementation status: 🔄 27% (21/79 deliverables complete)
656631

657632
.. list-table::
658633
:header-rows: 1
@@ -728,22 +703,6 @@ See :ref:`verification_workflows`.
728703
- ❌ Open
729704
- ❌ Open
730705

731-
* - Orchestrator
732-
- ✅ Available
733-
734-
| (2 tests)
735-
- ❌ Open
736-
- ✅ Available (9 tests)
737-
- ✅ Available (3 tests)
738-
739-
| `reference_integration <https://github.com/eclipse-score/reference_integration>`__ (cross-module)
740-
- ✅ 0 findings
741-
742-
| `Clippy <https://github.com/eclipse-score/orchestrator/blob/main/.github/workflows/clippy.yml>`__
743-
- ❌ Open
744-
- ❌ Open
745-
- ❌ Open
746-
747706
* - Persistency
748707
- ✅ Available
749708

docs/s_core_v_1/roadmap/pi1.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
🚀 PI 1 — 13 May – 13 July 2026 · `v0.8 <https://github.com/eclipse-score/score/milestone/30>`__
16-
==================================================================================================
15+
🚀 Release Gate v0.8 — 13 May – 13 July 2026
16+
=================================================
17+
18+
Milestone: `score/v0.8 <https://github.com/eclipse-score/score/milestone/30>`__
1719

1820
Focus: Requirements Engineering (PA2) + Architecture Design (PA3)
1921
------------------------------------------------------------------
@@ -46,7 +48,7 @@ See the relevant tables in :doc:`overall_status`:
4648
Feasibility Check
4749
-----------------
4850

49-
Do we have everything in place to deliver the PI 1 focus items?
51+
Do we have everything in place to deliver the Release Gate v0.8 focus items?
5052

5153
**Tooling & Process**
5254

@@ -70,11 +72,11 @@ Do we have everything in place to deliver the PI 1 focus items?
7072
- [ ] Every module's ``chklst_req_inspection.rst`` and ``chklst_arc_inspection.rst`` are reviewed and merged into the module repo
7173
- [ ] The overall status tracker (``overall_status.rst``) reflects the current state for each module
7274
- [ ] All tracked findings from inspections have a linked GitHub issue with component + milestone set
73-
- [ ] A final PI 1 review meeting confirms sign-off by module owners and process responsible
75+
- [ ] A final Release Gate v0.8 review meeting confirms sign-off by module owners and process responsible
7476

7577
**Integration in Reference Integration**
7678

7779
- [ ] All modules with completed requirements and architecture are integrated in this reference integration repository
7880
- [ ] The reference integration build passes (no broken imports, no unresolved need IDs)
79-
- [ ] The documentation (this site) builds without warnings for all PI 1 modules
80-
- [ ] The PI 1 status table in ``overall_status.rst`` is updated to reflect the final state
81+
- [ ] The documentation (this site) builds without warnings for all Release Gate v0.8 modules
82+
- [ ] The Release Gate v0.8 status table in ``overall_status.rst`` is updated to reflect the final state

0 commit comments

Comments
 (0)