Skip to content

docs-site: remove ADR references from the deck sources and builder - #197

Merged
Atom-oh merged 12 commits into
devfrom
docs-site/deck-sources-no-adr
Oct 24, 2026
Merged

Atom-oh merged 12 commits into
devfrom
docs-site/deck-sources-no-adr

Conversation

@Atom-oh

@Atom-oh Atom-oh commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Removes ADR references from the intro deck's 01-why-awsops and 03-demo-scenarios parts — Markdown source, per-part HTML rendering and the matching slide and speaker-note lines of the combined index.html — plus the PPTX builder and regenerated awsops-intro.pptx (verify-deck.sh passes), the related SVG/drawio assets and the screenshot script.

Merge order: #196, #197 and #205 are independent and can merge in any order (their index.html edits touch disjoint lines). Each carries its Markdown source block, its per-part HTML rendering and the matching lines of the combined index.html together, so no review sees a rendering diverge from its source; splitting this way keeps each review under the 128 KiB AI review input limit. #195 is superseded once all three merge.

🤖 Generated with Claude Code

Atom-oh and others added 3 commits October 22, 2026 04:08
Split from #192 to stay under the AI review input limit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Split from #192 to stay under the AI review input limit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Regenerates awsops-intro.pptx with scripts/pptx/build-awsops-intro-pptx.js
(verify-deck.sh passes); HTML is edited in step with its Markdown source.

Split from #192 to stay under the AI review input limit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

🤖 AI Code Review (two independent reviewers)

_Reviewer responses: codex/ALL claude/ALL _

Status: PASSED — No blocking issues found

All claims verified. The key facts: the real merge-base..HEAD diff includes a regenerated awsops-intro.pptx (2413598 → 2413110 bytes — the binary delta was merely elided from the review input), voiding the claude panel's L2 MAJOR per its own caveat; and HEAD's index.html does retain 25 ADR references, all in the untouched part-2 (architecture) slices, confirming the mixed-state observation — which I judge MINOR, since the PR is part of an explicit incremental de-ADR series (prior commit #201), breaks no CI gate or repo rule, and the touched slices are internally consistent.


Summary

PR #197 continues the docs-site de-ADR series (following #201), stripping ADR-number citations from the awsops-intro deck sources (parts 01/03, merged index.html slices, two SVGs, one drawio, the pptx builder) and from two comments in capture-screenshots.ts. No runtime code, Terraform, IAM, or data-integration logic is touched, and every rewritten sentence preserves the substantive read-only/frozen-mutation posture. The claude panel's two MAJORs do not survive chair verification: the committed awsops-intro.pptx was regenerated in HEAD (the binary delta was elided from the review diff; the builder at HEAD contains zero ADR references, so the verify-deck.sh parity gate is satisfiable), and the remaining part-2 ADR vocabulary in index.html is a transitional state of an incremental cleanup, not a defect.

Issues per lens

L2 — Code correctness

  • No blocking issues. Claude flagged MAJOR "pptx not regenerated → verify-deck.sh gate fails"; codex found nothing. Chair verification: claude's finding is void by its own stated condition — git diff --stat bb1c8d6..8c77267 shows awsops-intro.pptx | Bin 2413598 -> 2413110 bytes, and the HEAD builder has 0 ADR occurrences, so the deck was rebuilt from the updated generator. The stdin diff simply omitted the binary hunk. CI's merge-verify.yml → verify-deck.sh byte-parity gate will independently confirm the rebuild is exact.
  • MINOR (one model): the .md/.html/index.html deck triples are hand-edited in parallel with no regeneration check; the touched note bodies were verified in sync, so this is a fragility note only.
  • Only comment text changed in capture-screenshots.ts; the URL_POLICY.isApp predicate and /login branch are byte-identical. Builder edits keep balanced quotes/escapes inside the cols literals and addNotes template literals.

L3 — Security / AWS mutation safety

  • No blocking issues (both models agree). No Terraform/IAM/flag/AWS-calling code is in the diff; the ADR-005 freeze boundary is untouched by construction. Every rewritten sentence retains the substance: "AWS 리소스 변경·자율 실행 동결", "do-not-enable", get/list/watch-only K8s, single ReadOnly role, the SVG "READ-ONLY — no remediation" badge. No secrets/ARNs introduced.
  • MINOR (one model, verified in diff): revocability phrasing is now inconsistent — part 1 says bare "동결(FROZEN)" (qualifier dropped) while part 3 keeps "새 명시적 결정 전까지, 영구 아님". Pick one phrasing so the posture doesn't read as irreversible in one part and reversible in another.
  • MINOR (one model): the sole authorized mutation exception (ADR-015 owner-override) is now anonymous ("단일 문서화 예외: … 웹 재시작"). CLAUDE.md defines it precisely and warns against conflation with non-exceptions; if ADR numbers must go, describe it functionally (secret-rotation-triggered ecs:UpdateService force-new-deployment, 1 IAM ARN, default-off) rather than leaving it unidentifiable.

L4 — Observability / data-integration correctness

  • No blocking issues (both models agree). No Steampipe SQL, CIS/Powerpipe, or AgentCore diagnosis code changed. The de-ADR'd factual claims remain accurate against BASE: steampipeAvailable() hard-false/fail-open path, the digest bullet's "approved scope = scheduled summaries, current implementation batches manual runs too" (matches diagnosis_digest.py behavior, and fixes the malformed "ADR-13" citation in the touched slices).
  • MINOR (one model): security-findings-pipeline.svg replacement text "per account" is semantically empty under a node already labeled "read-only fan-out"; use something substantive (e.g. "ExternalId · read-only role") or drop the line.
  • Positive: shortening the compliance-benchmark-flow.svg badge text fixes a latent clipping overflow of the 280px pill.

L5 — Docs/ADR consistency

  • MINOR (downgraded from one model's MAJOR) — index.html ships in a mixed state. Verified at HEAD: 25 ADR references remain, all in the part-2 (architecture) slices, including user-visible slide headers ("Hybrid Routing & Streaming Chat — ADR-003", "Multi-Account — STS AssumeRole Fan-Out (ADR-011)"), the malformed "ADR-13" in the part-2 workers slide, and presenter notes 14–20/30; 02-architecture.{md,html} are untouched. This is real, but it is the expected intermediate state of an explicit incremental series (docs-site: remove ADR references from overview, monitoring, security and compute pages #201 preceded this PR), violates no CI gate or CLAUDE.md rule, and the untouched files are out of diff scope. It should be finished in a follow-up PR (02-architecture + the matching index.html slices), and the PR body should state that sequencing.
  • All three removed [출처] … docs/decisions/BASELINE.md blocks pointed at a path that does not exist in this public tree (ADRs live in the private upstream per CLAUDE.md), "ADR-042" was outside the documented 001–021 range, and "ADR-13" was malformed — these removals are strict improvements (one model verified; the other concurs at summary level).
  • MINOR (one model): the governance slide now ends with neither [약어] nor [출처] while four other slides keep [출처] blocks pointing at real in-tree paths; consider re-anchoring the governance slide at the in-tree invariant documentation.
  • Note: ADR citations remain pervasive outside docs-site (CLAUDE.md, docs/reference, code comments). If de-ADR'ing docs-site is now policy, amend CLAUDE.md's "docs here cite ADRs by number" sentence to scope it.

Suggestions

  1. Follow-up PR: de-ADR 02-architecture.{md,html} and the corresponding index.html part-2 slices (including the slide headers and the "ADR-13" in slide s13) so the merged deck uses one vocabulary; reference it in this PR's description.
  2. Unify the FROZEN phrasing — keep the "until a new explicit decision, not permanent" qualifier everywhere or nowhere.
  3. Give the single mutation exception a functional description (trigger, action, 1-ARN scope, default-off) in the governance and FAQ slides.
  4. Replace the SVG "per account" line with substantive text or remove it.

Verdict

No CRITICAL or MAJOR finding survives verification against the actual merge-base..HEAD diff: the pptx parity concern is factually void (deck was rebuilt), and the mixed-vocabulary state is a scoped, non-blocking consistency note in an incremental cleanup series. Image manifest lists no images.

IMAGE_COVERAGE: NOT_REQUIRED


Triggered by commit 8c7726775ef35bceea1640c3fee39ed458d92dab · workflow: .github/workflows/pr-review.yml

Atom-oh and others added 5 commits October 22, 2026 23:49
Keep the facts the ADR removal dropped: the diagnosis digest's approved
scope is the scheduled summary while the implementation also batches
manual runs, and lifting the AWS-mutation freeze needs a new decision
document, a multi-AI panel review and a dated owner approval.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep the facts the ADR removal dropped: the diagnosis digest's approved
scope is the scheduled summary while the implementation also batches
manual runs, and lifting the AWS-mutation freeze needs a new decision
document, a multi-AI panel review and a dated owner approval.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep the facts the ADR removal dropped: the diagnosis digest's approved
scope is the scheduled summary while the implementation also batches
manual runs, and lifting the AWS-mutation freeze needs a new decision
document, a multi-AI panel review and a dated owner approval.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Atom-oh
Atom-oh changed the base branch from dev to docs-site/deck-architecture-no-adr October 22, 2026 23:49
Atom-oh and others added 2 commits October 24, 2026 06:59
… PRs

The architecture section (#196) and the regenerated combined index.html
(#195, merged last) carry their own changes, so each review stays under
the input limit with its sources and renderings together.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
index.html renders the same blocks, so the why-awsops and demo-scenario
slide and speaker-note lines change with their sources in this PR.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Atom-oh
Atom-oh deployed to ci-review-auto October 24, 2026 07:16 — with GitHub Actions Active
@Atom-oh
Atom-oh merged commit 0756f2b into dev Oct 24, 2026
6 checks passed

This branch had an error being deployed

1 failed (outdated) and 1 active deployments
ci-review-auto — 8c772677 Deployed Oct 24, 2026 by Atom-oh via AI Code Review #789
ci-review-recovery — 92c9e6a8 Deployed Oct 24, 2026 by Atom-oh via AI Code Review #784
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant