|
| 1 | +# AGENTS |
| 2 | + |
| 3 | +## How To Orient In This Repo |
| 4 | + |
| 5 | +Start with `CURRENT_STATE.md` for the current audit summary, then read `docs/agentic-first-buildout-plan.md` for the branch/PR/QA loop, then read `README.md` for the public-facing intent. The canonical site content lives in `index.md`, the site metadata lives in `_config.yml`, and the primary visualization asset is `oral-health-heatmap.png`. |
| 6 | + |
| 7 | +## Canonical Source-Of-Truth Files |
| 8 | + |
| 9 | +- `CURRENT_STATE.md`: current repository truth and known risks |
| 10 | +- `docs/agentic-overhaul/2026-05-audit.md`: fuller audit, maturity scores, and backlog |
| 11 | +- `README.md`: public overview of the project |
| 12 | +- `index.md`: rendered GitHub Pages content |
| 13 | +- `_config.yml`: site title, description, and theme config |
| 14 | +- `Gemfile` and `.ruby-version`: pinned local Jekyll toolchain |
| 15 | +- `assets/css/style.scss.css`: hand-authored site styling |
| 16 | +- `oral-health-heatmap.png`: published visualization asset |
| 17 | +- `Figure2-Teeth_v4.1.pdf`: committed source figure for the PNG |
| 18 | +- `scripts/render_heatmap.py`: source-to-raster rebuild script |
| 19 | +- `scripts/check_homepage.py`: homepage smoke test script |
| 20 | +- `docs/heatmap-provenance.md`: provenance and rebuild notes |
| 21 | + |
| 22 | +## Commands To Run Before And After Changes |
| 23 | + |
| 24 | +Before changes: |
| 25 | + |
| 26 | +- `git status --short` |
| 27 | +- `python scripts/validate_repo.py` |
| 28 | +- `python scripts/render_heatmap.py` if you touch the heatmap source artifact or rebuild notes |
| 29 | +- `python scripts/check_homepage.py` if you touch the homepage render or nav |
| 30 | + |
| 31 | +After changes: |
| 32 | + |
| 33 | +- `python scripts/validate_repo.py` |
| 34 | +- `bundle exec jekyll build` |
| 35 | +- `git status --short` |
| 36 | + |
| 37 | +The repo now pins the local Jekyll toolchain with `Gemfile` and `.ruby-version`. Do not claim build parity unless you have run the pinned build command successfully. |
| 38 | + |
| 39 | +## Generated Vs. Hand-Authored Files |
| 40 | + |
| 41 | +Hand-authored: |
| 42 | + |
| 43 | +- `README.md` |
| 44 | +- `index.md` |
| 45 | +- `_config.yml` |
| 46 | +- `Gemfile` |
| 47 | +- `.ruby-version` |
| 48 | +- `assets/css/style.scss.css` |
| 49 | +- `CURRENT_STATE.md` |
| 50 | +- `docs/agentic-overhaul/2026-05-audit.md` |
| 51 | +- `AGENTS.md` |
| 52 | +- `docs/heatmap-provenance.md` |
| 53 | +- `docs/agentic-first-buildout-plan.md` |
| 54 | +- `scripts/render_heatmap.py` |
| 55 | +- `scripts/check_homepage.py` |
| 56 | + |
| 57 | +Generated or historical artifact: |
| 58 | + |
| 59 | +- `README.CRAWL.md`: historical crawl output with stale machine-local metadata; do not treat as canonical truth |
| 60 | + |
| 61 | +## Data, Citation, And Provenance Rules |
| 62 | + |
| 63 | +- Do not invent dataset provenance, participant counts, or publication claims beyond what is already supported in committed files. |
| 64 | +- If you add provenance notes, tie them to already-present citation material or newly committed source artifacts. |
| 65 | +- If the image can be regenerated, document the real pipeline; do not guess at unpublished steps. |
| 66 | +- Keep the source PDF and rebuild script in sync with `oral-health-heatmap.png`. |
| 67 | + |
| 68 | +## Accessibility And Documentation Expectations |
| 69 | + |
| 70 | +- Preserve meaningful alt text for the main image and any future visual assets. |
| 71 | +- Keep README and `CURRENT_STATE.md` aligned when commands or repo structure change. |
| 72 | +- Favor small, explicit documentation updates over implied behavior. |
| 73 | + |
| 74 | +## Safe-Change Rules |
| 75 | + |
| 76 | +- Keep the repo lightweight; avoid introducing heavy tooling unless the site grows. |
| 77 | +- Do not hand-edit generated artifacts if a real generator is introduced later. |
| 78 | +- Prefer edits that preserve GitHub Pages compatibility. |
| 79 | +- Avoid deleting historical artifacts unless their role is documented and the removal is clearly safe. |
| 80 | + |
| 81 | +## Known Project-Specific Traps |
| 82 | + |
| 83 | +- `README.CRAWL.md` includes stale machine-local paths and a directory count from another environment. |
| 84 | +- The repo now pins the Jekyll toolchain, so local Pages rendering can be verified once Ruby is installed. |
| 85 | +- The visualization image is committed, and the committed source PDF plus rebuild script provide the regeneration path. |
0 commit comments