Skip to content

Commit 5fb73ee

Browse files
committed
docs: record historical artifact qa
1 parent 80e132e commit 5fb73ee

3 files changed

Lines changed: 64 additions & 7 deletions

File tree

CURRENT_STATE.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,16 @@ This repository is a small GitHub Pages static site that publishes a single oral
2323

2424
- A local homepage QA snapshot passed `python scripts/check_homepage.py` and was then captured at desktop and mobile widths in a browser-rendered view.
2525
- The browser captures showed the heatmap image, page heading, and download link in the expected positions with no visible layout regressions.
26+
- Historical artifact governance passed non-UI QA: `python scripts/validate_repo.py`, Python script compilation, policy-doc discoverability checks, and `_config.yml` exclusion checks.
27+
- Live GitHub Pages QA returned HTTP 200, found the expected title and heatmap, and did not find a `README.CRAWL.html` link.
2628

2729
## Existing Commands
2830

2931
| Command | Purpose | Result |
3032
| --- | --- | --- |
3133
| `python scripts/validate_repo.py` | Repo validation | Pass with warning about stale `README.CRAWL.md` |
32-
| `python scripts/render_heatmap.py` | Heatmap rebuild | Produces the published 1700 x 2200 PNG from the committed PDF source at 200 DPI |
33-
| `python scripts/check_homepage.py` | Homepage smoke test | Verifies the rendered homepage title, heading, heatmap image, alt text, download link, and the absence of README.CRAWL.html |
34+
| `python scripts/render_heatmap.py` | Heatmap rebuild | Currently blocked locally by Windows/MiKTeX `pdftoppm` temp/log permission errors |
35+
| `python scripts/check_homepage.py` | Homepage smoke test | Requires `_site/index.html` from a Jekyll build, or an explicit rendered HTML path or URL |
3436
| `Invoke-WebRequest https://mschwar.github.io/data-visualization/` | Live site verification | 200 OK |
3537
| `bundle exec jekyll build` | Local Jekyll build | Not run in this environment because Ruby was unavailable at audit time |
3638

@@ -60,11 +62,12 @@ The pinned build path is now committed in-repo, so local build instructions are
6062

6163
- Local GitHub Pages rendering is not reproducible from committed tooling in the current environment.
6264
- Local build execution still depends on having Ruby installed on the host.
65+
- Heatmap rebuild execution is currently blocked in this Windows environment by MiKTeX `pdftoppm` permission errors.
6366
- The historical source dataset that fed the original figure is still not published in this repo.
6467
- `README.CRAWL.md` remains as a historical artifact but is excluded from the public site.
6568

6669
## Immediate Next Moves
6770

68-
1. QA the historical artifact governance branch by confirming `README.CRAWL.md` stays out of the public site and the new policy doc stays discoverable.
69-
2. Keep `scripts/render_heatmap.py` and `Figure2-Teeth_v4.1.pdf` in sync if the figure changes.
70-
3. Run `python scripts/check_homepage.py` against `_site/index.html` after a local build if you need a homepage smoke check.
71+
1. Start provenance refinement from [docs/agentic-first-buildout-plan.md](docs/agentic-first-buildout-plan.md).
72+
2. Track the follow-on fixes listed in [docs/agentic-first-buildout-plan.md](docs/agentic-first-buildout-plan.md).
73+
3. Keep historical artifacts documented in [docs/historical-artifacts.md](docs/historical-artifacts.md).

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,23 @@ Run:
5454

5555
```bash
5656
python scripts/validate_repo.py
57+
```
58+
59+
This checks for required files, obvious broken local references, key site metadata, and committed OS junk files.
60+
61+
After rendering the site, run the homepage smoke test against the generated page:
62+
63+
```bash
64+
bundle exec jekyll build
5765
python scripts/check_homepage.py
5866
```
5967

60-
This checks for required files, obvious broken local references, key site metadata, committed OS junk files, and the rendered homepage shape.
68+
You can also pass an explicit rendered HTML path or live URL:
69+
70+
```bash
71+
python scripts/check_homepage.py _site/index.html
72+
python scripts/check_homepage.py https://mschwar.github.io/data-visualization/
73+
```
6174

6275
## Rebuild Locally
6376

docs/agentic-first-buildout-plan.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,15 @@ Start the remaining buildout here:
6060

6161
### 3. Historical artifact governance
6262

63-
- Status: next.
63+
- Status: merged to main.
6464
- Goal: decide the final treatment of `README.CRAWL.md` and any other historical artifacts.
6565
- Merge boundary: docs and navigation only.
6666
- Verification: non-UI validation plus live site check that the artifact is not surfaced publicly.
6767
- Why third: it resolves repo hygiene after the public experience is stable.
6868

6969
### 4. Provenance refinement
7070

71+
- Status: next.
7172
- Goal: tighten the provenance story around the source PDF, the published PNG, and any constraints on regeneration.
7273
- Merge boundary: documentation only.
7374
- Verification: non-UI link/file validation.
@@ -80,6 +81,46 @@ Start the remaining buildout here:
8081
- Verification: explicit non-UI command or GitHub Actions status.
8182
- Why last: deployment checks are most useful after the content and verification paths are stable.
8283

84+
## Follow-On Feature List
85+
86+
These are known missing or non-working items discovered during repo audit. Keep them as separate branches unless one is clearly part of the current feature.
87+
88+
### A. Homepage Smoke-Test Documentation Fix
89+
90+
- Problem: `python scripts/check_homepage.py` fails on a fresh checkout until `_site/index.html` exists.
91+
- Fix: document that the command requires `bundle exec jekyll build` first, or pass an explicit rendered HTML path or live URL.
92+
- Verification: run `python scripts/check_homepage.py <rendered-html-or-url>`.
93+
94+
### B. Windows Heatmap Render Robustness
95+
96+
- Problem: `python scripts/render_heatmap.py` fails in this Windows environment because MiKTeX `pdftoppm` cannot write its log/temp output under `AppData\Local`.
97+
- Fix: make the render script use a repo-local writable temp/output path or document the required MiKTeX environment variables.
98+
- Verification: run `python scripts/render_heatmap.py` and confirm `git diff -- oral-health-heatmap.png` is empty or expected.
99+
100+
### C. Local Jekyll Bootstrap
101+
102+
- Problem: local Jekyll builds remain unavailable in this environment because Ruby and Bundler are not installed.
103+
- Fix: add a Windows-friendly bootstrap note or setup script that installs/validates Ruby 3.3.4 and Bundler without changing the pinned CI build.
104+
- Verification: run `ruby -v`, `bundle -v`, and `bundle exec jekyll build`.
105+
106+
### D. Live Site Verification
107+
108+
- Problem: live GitHub Pages verification is currently ad hoc.
109+
- Fix: add a repeatable command or workflow step that checks the deployed URL after merge.
110+
- Verification: HTTP 200 plus expected title, heatmap image, and no `README.CRAWL.html` link.
111+
112+
### E. Source Dataset Provenance
113+
114+
- Problem: the source dataset behind the original heatmap is not published in this repository.
115+
- Addition: document whether the source dataset can be shared, cannot be shared, or lives in a controlled-access location.
116+
- Verification: non-UI documentation/link check.
117+
118+
### F. Audit Document Refresh
119+
120+
- Problem: the maturity score in `docs/agentic-overhaul/2026-05-audit.md` is stale after the build, CI, validation, and provenance improvements.
121+
- Fix: update scores and backlog so the audit reflects the current repo.
122+
- Verification: `python scripts/validate_repo.py`.
123+
83124
## Handoff Rules
84125

85126
- Keep the plan discoverable by updating `CURRENT_STATE.md` when the next feature changes.

0 commit comments

Comments
 (0)