Skip to content

Commit c7d75ba

Browse files
committed
docs(overall_status): enlarge status headings and add rollout progress bar
- Style 'Process Status' rubrics with new .status-heading class for larger, bolder appearance. - Replace 'Implementation status: ...' rubrics with an inline 'Rollout status' row containing label, percentage, progress bar and detail text in one line. - Add corresponding CSS in docs/_assets/custom.css (.status-heading, .impl-status-row and .impl-status-bar/.impl-status-fill).
1 parent 6018c27 commit c7d75ba

3 files changed

Lines changed: 152 additions & 16 deletions

File tree

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

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ COV_RE = re.compile(
354354
### 4.2 PA5 — static / dynamic analysis CI table
355355

356356
> **Reader notes (rendered in the RST as `.. note::` blocks placed
357-
> immediately after the PA5 `Implementation status:` rubric and before
357+
> immediately after the PA5 `Rollout status` row and before
358358
> the PA5 list-table — keep them in sync when regenerating):**
359359
>
360360
> 1. **C0/C1 Coverage source.** Coverage data comes from the
@@ -573,9 +573,14 @@ to read. All other PAs keep the default 720px width.
573573

574574
### 5.4 Pie chart row (Process Status)
575575

576-
Each PA section starts with a pie chart row.
576+
Each PA section starts with a pie chart row. The section is introduced by a
577+
**Process Status** rubric that uses the `status-heading` class for an
578+
enlarged appearance (styles in `docs/_assets/custom.css`):
577579

578580
```rst
581+
.. rubric:: Process Status
582+
:class: status-heading
583+
579584
.. list-table::
580585
:header-rows: 1
581586
:class: compact-overview-table
@@ -620,17 +625,39 @@ Hard rules:
620625
`compact-overview-table`, fluid 33% per column, `!important` img override).
621626
Do not add explicit pixel sizes.
622627

623-
### 5.4 Implementation status rubric
628+
### 5.4 Rollout status row
624629

625-
Directly above the module tracker table:
630+
Directly above the module tracker table, render a **single-line row** with
631+
a label, percentage, an inline progress bar and a detail text. This
632+
replaces the older `.. rubric:: Implementation status: ...` line. Use a
633+
`raw:: html` block so the progress bar and the text sit on the same line:
626634

627635
```rst
628-
.. rubric:: Implementation status: 🔄 NN% (X/Y deliverables complete)
636+
.. raw:: html
637+
638+
<div class="impl-status-row">
639+
<span class="impl-status-label">Rollout status:</span>
640+
<span class="impl-status-icon">🔄</span>
641+
<span class="impl-status-percent">NN%</span>
642+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:NN%"></div></div>
643+
<span class="impl-status-detail">X/Y deliverables complete</span>
644+
</div>
629645
```
630646

631-
`X` = number of `✅ Available` cells in the table; `Y` = number of cells in
632-
the table excluding the leftmost stub column. Both rubrics in a PA section
633-
(`Process Status` and `Implementation status`) are inline text, not headings.
647+
- `X` = number of `✅ Available` cells in the table.
648+
- `Y` = number of cells in the table excluding the leftmost stub column.
649+
- `NN` = `floor(100 * X / Y)`, clamped to `[0, 100]`. Use the **same**
650+
value in both the `impl-status-percent` span and the
651+
`style="width:NN%"` of `impl-status-fill`.
652+
- If `Y == 0`, render `NN = 0` (empty bar) and `0/0 deliverables complete`.
653+
- Keep the wording **"Rollout status"** — not "Implementation status"
654+
(the term "implementation" is reserved for actual code).
655+
- Styling lives in `docs/_assets/custom.css` (`.impl-status-row`,
656+
`.impl-status-bar`, `.impl-status-fill`). Do not inline additional
657+
styles beyond the `width:NN%` on the fill div.
658+
- The `Process Status` rubric above the pie row uses the
659+
`:class: status-heading` option (see §5.4 above) so both headings have
660+
the same enlarged appearance.
634661

635662
---
636663

@@ -841,9 +868,10 @@ Stop and investigate if:
841868

842869
### Step 6 — Write the RST
843870

844-
Update each PA's module table and the `.. rubric:: Implementation status:`
845-
line. Source links as in §5.2. Pie-chart row stays unchanged unless the
846-
sphinx-needs tag changes.
871+
Update each PA's module table and the **Rollout status** `raw:: html`
872+
block above it (see §5.4). Source links as in §5.2. Pie-chart row and the
873+
`Process Status` rubric stay unchanged unless the sphinx-needs tag
874+
changes.
847875

848876
### Step 7 — Adding a new module
849877

docs/_assets/custom.css

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,3 +230,66 @@ table .line-block .line {
230230
margin: 0;
231231
font-size: 1.1rem;
232232
}
233+
234+
/* ---------------------------------------------------------------------------
235+
* Process / Implementation status headings (overall_status.rst):
236+
* make rubric headings visually larger, and render the implementation
237+
* status as a single inline row with a progress bar.
238+
* ---------------------------------------------------------------------------*/
239+
240+
p.rubric.status-heading,
241+
.rubric.status-heading {
242+
font-size: 1.35rem;
243+
font-weight: 700;
244+
margin-top: 1.2rem;
245+
margin-bottom: 0.6rem;
246+
color: #1a5fa8;
247+
}
248+
249+
.impl-status-row {
250+
display: flex;
251+
flex-wrap: wrap;
252+
align-items: center;
253+
gap: 0.6rem;
254+
font-size: 1.35rem;
255+
font-weight: 700;
256+
color: #1a5fa8;
257+
margin: 1.2rem 0 0.8rem 0;
258+
}
259+
260+
.impl-status-row .impl-status-label {
261+
white-space: nowrap;
262+
}
263+
264+
.impl-status-row .impl-status-icon {
265+
font-size: 1.25rem;
266+
}
267+
268+
.impl-status-row .impl-status-percent {
269+
min-width: 3.5rem;
270+
text-align: right;
271+
}
272+
273+
.impl-status-row .impl-status-bar {
274+
flex: 1 1 200px;
275+
min-width: 160px;
276+
max-width: 360px;
277+
height: 14px;
278+
background-color: #e3e8ef;
279+
border: 1px solid #c0c8d4;
280+
border-radius: 7px;
281+
overflow: hidden;
282+
}
283+
284+
.impl-status-row .impl-status-fill {
285+
height: 100%;
286+
background: linear-gradient(90deg, #1a5fa8 0%, #4a90d9 100%);
287+
border-radius: 6px 0 0 6px;
288+
}
289+
290+
.impl-status-row .impl-status-detail {
291+
font-size: 1rem;
292+
font-weight: 500;
293+
color: #444;
294+
white-space: nowrap;
295+
}

docs/s_core_v_1/roadmap/overall_status.rst

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Process Area 1 — Change Management
2020
----------------------------------
2121

2222
.. rubric:: Process Status
23+
:class: status-heading
2324

2425
.. list-table::
2526
:header-rows: 1
@@ -58,7 +59,15 @@ Process Area 1 — Change Management
5859
:filter-func: needs_filters.area_verification_status(change_management)
5960

6061

61-
.. rubric:: Implementation status: 🔄 90% (10/11 deliverables complete)
62+
.. raw:: html
63+
64+
<div class="impl-status-row">
65+
<span class="impl-status-label">Rollout status:</span>
66+
<span class="impl-status-icon">🔄</span>
67+
<span class="impl-status-percent">90%</span>
68+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:90%"></div></div>
69+
<span class="impl-status-detail">10/11 deliverables complete</span>
70+
</div>
6271

6372

6473
.. list-table::
@@ -118,6 +127,7 @@ Process Area 2 — Requirements Engineering
118127
-----------------------------------------
119128

120129
.. rubric:: Process Status
130+
:class: status-heading
121131

122132
.. list-table::
123133
:header-rows: 1
@@ -163,7 +173,15 @@ Process Area 2 — Requirements Engineering
163173
Total Feature and Component Requirements across the 11 PA2 modules per release (v0.5.0-beta → v0.6.0 → v0.7.0 → current main).
164174

165175

166-
.. rubric:: Implementation status: 🔄 39% (13/33 deliverables complete)
176+
.. raw:: html
177+
178+
<div class="impl-status-row">
179+
<span class="impl-status-label">Rollout status:</span>
180+
<span class="impl-status-icon">🔄</span>
181+
<span class="impl-status-percent">39%</span>
182+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:39%"></div></div>
183+
<span class="impl-status-detail">13/33 deliverables complete</span>
184+
</div>
167185

168186

169187
.. list-table::
@@ -280,6 +298,7 @@ Process Area 3 — Architecture Design
280298
------------------------------------
281299

282300
.. rubric:: Process Status
301+
:class: status-heading
283302

284303
.. list-table::
285304
:header-rows: 1
@@ -325,7 +344,15 @@ Process Area 3 — Architecture Design
325344
Total Feature and Component Architecture elements across the 11 PA2 modules per release (v0.5.0-beta → v0.6.0 → v0.7.0 → current main).
326345

327346

328-
.. rubric:: Implementation status: 🔄 24% (8/33 deliverables complete)
347+
.. raw:: html
348+
349+
<div class="impl-status-row">
350+
<span class="impl-status-label">Rollout status:</span>
351+
<span class="impl-status-icon">🔄</span>
352+
<span class="impl-status-percent">24%</span>
353+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:24%"></div></div>
354+
<span class="impl-status-detail">8/33 deliverables complete</span>
355+
</div>
329356

330357

331358
.. list-table::
@@ -440,6 +467,7 @@ Process Area 4 — Implementation
440467
-------------------------------
441468

442469
.. rubric:: Process Status
470+
:class: status-heading
443471

444472
.. list-table::
445473
:header-rows: 1
@@ -485,7 +513,15 @@ Process Area 4 — Implementation
485513
Estimated Lines of Code across the 11 PA2 modules per release (v0.5.0-beta → v0.6.0 → v0.7.0 → current main).
486514

487515

488-
.. rubric:: Implementation status: 🔄 47% (21/44 deliverables complete)
516+
.. raw:: html
517+
518+
<div class="impl-status-row">
519+
<span class="impl-status-label">Rollout status:</span>
520+
<span class="impl-status-icon">🔄</span>
521+
<span class="impl-status-percent">47%</span>
522+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:47%"></div></div>
523+
<span class="impl-status-detail">21/44 deliverables complete</span>
524+
</div>
489525

490526

491527
.. list-table::
@@ -613,6 +649,7 @@ Process Area 5 — Verification
613649
-----------------------------
614650

615651
.. rubric:: Process Status
652+
:class: status-heading
616653

617654
.. list-table::
618655
:header-rows: 1
@@ -658,7 +695,15 @@ Process Area 5 — Verification
658695
Test counts and coverage across the 11 PA2 modules per release (v0.5.0-beta → v0.6.0 → v0.7.0 → current main).
659696

660697

661-
.. rubric:: Implementation status: 🔄 28% (25/88 deliverables complete)
698+
.. raw:: html
699+
700+
<div class="impl-status-row">
701+
<span class="impl-status-label">Rollout status:</span>
702+
<span class="impl-status-icon">🔄</span>
703+
<span class="impl-status-percent">28%</span>
704+
<div class="impl-status-bar"><div class="impl-status-fill" style="width:28%"></div></div>
705+
<span class="impl-status-detail">25/88 deliverables complete</span>
706+
</div>
662707

663708
.. note::
664709

0 commit comments

Comments
 (0)