Skip to content

Commit f9ba6c6

Browse files
docs(planning): amend Phase 2.8 acceptance to reflect scaffold-only completion
QA second-pass review of f3b56d3 (Batch 3) caught a documentation-drift gap: the commit body for f3b56d3 claimed Phase 2.8 acceptance was "amended" from a live URL to "scaffold + workflow + build green; deploy at Phase 3.4 public flip", but the actual Phase 2.8 row in `docs/PUBLIC_RELEASE_PLAN.md` was never updated. Future contributors reading the plan would see "live URL by Phase 2.8" and conclude the docs site is already published — inconsistent with the current private-repo gated deploy. Amends row 2.8 to make the gating explicit and references the private-repo guard at the JOB level in `.github/workflows/docs.yml`. The 2-3 hr estimate is also re-scoped to "scaffold only; deploy verification belongs to Phase 3.4". No code change. No CI impact (docs-only edit, no path filter trigger). Logged as `documentation-drift` to ~/.claude/state/qa-findings.jsonl for the bi-weekly QA pattern audit. Doc-drift: passes (30 docs / build 660).
1 parent f3b56d3 commit f9ba6c6

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/PUBLIC_RELEASE_PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ README reads as a finished product.
178178
| 2.5 | CODE_OF_CONDUCT.md (Contributor Covenant 2.1) | Standard text | 15 min |
179179
| 2.6 | GitHub issue templates (bug, feature, security, question) | `.github/ISSUE_TEMPLATE/` populated | 45 min |
180180
| 2.7 | PR template at `.github/PULL_REQUEST_TEMPLATE.md` | Covers test plan, screenshots, verification | 15 min |
181-
| 2.8 | MkDocs Material scaffold: `mkdocs.yml` + `docs/<index>.md` + nav + theme + `.github/workflows/docs.yml` deploying to GitHub Pages | `https://relativisticjet.github.io/wl_manager/` live | 2-3 hr |
181+
| 2.8 | MkDocs Material scaffold: `mkdocs.yml` + `docs/<index>.md` + nav + theme + `.github/workflows/docs.yml` deploying to GitHub Pages | Scaffold + workflow exist; `build` job green on every PR; deploy job present and gated on `github.event.repository.private == false`. **Live URL `https://relativisticjet.github.io/wl_manager/` does not deploy until Phase 3.4 flips the repo public** — Pages on a private free repo would 404 on the deploy API. | 2-3 hr (scaffold only; deploy verification belongs to Phase 3.4) |
182182
| 2.9 | Migrate existing docs (SBOM, INSTALLATION, RUNBOOKS, DECISION_LOG, SPLUNK_QUIRKS, etc.) into MkDocs nav | All accessible from site nav | 1-2 hr |
183183
| 2.10 | README rewrite for public audience: hero, value prop, install, RBAC, badges, link to hosted docs | Reads like a finished product | 3-4 hr |
184184
| 2.11 | GitHub repo settings: topics, description, homepage URL, social preview image | Discoverability optimized; topics include `splunk`, `splunkbase`, `siem`, `soc-tools`, `splunk-enterprise-security`, `detection-engineering` | 30 min |

0 commit comments

Comments
 (0)