Add production readiness checklist v3 with implementation decisions - #53
Conversation
Supersedes v2 with a decision-first edition: a Decision Log (D1–D10) that records every choice from the framework review as ready-to-implement instructions (universal-base scope, base behaviour-token wiring, contrast-bias implementation, forms distribution/bundle scheme, states↔forms integration, button hover fix, required-asterisk, explicit rejections), plus corrected scores that credit existing tooling (stylelint/CI/commitlint/hooks), inventory the three stub files, and a prioritised road to v1.0. No framework code changed. https://claude.ai/code/session_01AsRUmGk1efwLcreDfQvXNZ
Rebuild §C as a complete to-do inventory: every not-done item from v2 (✗/🟡/⚠, all priorities including LOW) reproduced as per-layer tables with decision tags, so nothing from v2 is lost. Restores items previously trimmed (select-arrow cross-browser, form-group, icon primitive, sf-blink/sf-float, scroll-driven utilities, @starting-style, prefers-reduced-data, ARIA live regions, print named-pages/page-break, separate layers entry, migration guide, colour-naming doc, and the rest of the LOW tail). Completed rows omitted by design; rejected items stay in §D9. https://claude.ai/code/session_01AsRUmGk1efwLcreDfQvXNZ
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds ChangesProduction Readiness Checklist v3 Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
audits/completion-checklist-v3.md (1)
89-134: 💤 Low valueConsider expanding the ellipsis notation for implementation clarity.
Lines 123-124 use
"…h2–h6 identically…"as shorthand. While the pattern is clear (addfont-weight: var(--sf-hN-font-weight)to each heading), an implementer might appreciate seeing the complete diff for at least one more heading (h2) to eliminate ambiguity. The regression guard for--sf-body-strong-weightis excellent.📝 Optional: show h2 explicitly
h1 { font-size: var(--sf-h1-size); line-height: var(--sf-h1-line-height); font-weight: var(--sf-h1-font-weight); letter-spacing: var(--sf-h1-letter-spacing); } +h2 { font-size: var(--sf-h2-size); line-height: var(--sf-h2-line-height); font-weight: var(--sf-h2-font-weight); letter-spacing: var(--sf-h2-letter-spacing); } +/* h3–h6 follow the same pattern */🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@audits/completion-checklist-v3.md` around lines 89 - 134, The diff uses an ellipsis ("…h2–h6 identically…") which may cause ambiguity; update core/base.css to show at least one additional explicit heading rule (e.g., the h2 rule) mirroring the h1 pattern so implementers see the exact format to apply (include font-weight: var(--sf-h2-font-weight), size/line-height vars and letter-spacing), and ensure core/tokens.css has the adjusted default for --sf-body-strong-weight set to var(--sf-font-weight-bold) so b/strong map to 700; reference the h1/h2 rules, --sf-hN-font-weight tokens, and --sf-body-strong-weight when making the changes.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@audits/completion-checklist-v3.md`:
- Around line 89-134: The diff uses an ellipsis ("…h2–h6 identically…") which
may cause ambiguity; update core/base.css to show at least one additional
explicit heading rule (e.g., the h2 rule) mirroring the h1 pattern so
implementers see the exact format to apply (include font-weight:
var(--sf-h2-font-weight), size/line-height vars and letter-spacing), and ensure
core/tokens.css has the adjusted default for --sf-body-strong-weight set to
var(--sf-font-weight-bold) so b/strong map to 700; reference the h1/h2 rules,
--sf-hN-font-weight tokens, and --sf-body-strong-weight when making the changes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 5a2522f6-0daa-49f1-9279-c331774393ba
📒 Files selected for processing (1)
audits/completion-checklist-v3.md
Re-scoring leaked "decided" items as if implemented. Fix: Forms back to 67% and Internal Consistency to 55% (D2/D3/D6/D7/D8 are reverted/unimplemented and remain outstanding in §C); drop the unjustified Tokens +2. Only legitimate up:lift kept — scope reclassification (D1 out-of-scope, D9 rejected) and crediting pre-existing tooling (stylelint/CI/commitlint/hooks). Overall 78% → 76%. Adds a header stating decisions don't change the score, only implementation does. https://claude.ai/code/session_01AsRUmGk1efwLcreDfQvXNZ
Summary
This PR introduces
audits/completion-checklist-v3.md, a comprehensive production readiness audit that supersedes v2. Unlike v2 (which was an inventory), v3 is implementation-ready: it documents decisions made after auditing the codebase against the checklist, specifies exact changes needed, lists deliberate rejections, and provides a roadmap to v1.0.Key Changes
Decision Log (§A): 10 finalized decisions with exact code changes:
--sf-h1-font-weight, text-wrap, strong-weight, em-style)--sf-contrast-biasas a global text-contrast knob--sf-print-base-sizein print.css--sf-field-border-color:hoverbug (misuse of surface-hover token):has()+:requiredVerification Results (§B): Line-by-line audit against source confirming:
optional/components.css,optional/utilities.css,optional/tokens.components.css) inventoriedslashed.formslayer confirmed in 14-layer cascade but missing from README and architecture.md docsOutstanding Items (§C): Complete carryover from v2 with status updates and decision tags linking to §A
Deliberate Rejections (§D9): Rationale for NOT implementing animation utility classes, accent color, switch toggle, helper text, color partials, gradient variants, and pre-compiled themes
Re-scored Summary (§E): Base layer re-scored 77% → 90% (widgets reclassified as out-of-scope by design); Build re-scored 50% → 70% (existing infra credited); overall 72% → ~78% production-ready
Roadmap (§F): Three-phase execution plan:
Notable Implementation Details
@layerordering (physical concatenation order irrelevant)This document is not yet implemented — it is the instruction set for implementation.
https://claude.ai/code/session_01AsRUmGk1efwLcreDfQvXNZ
Summary by CodeRabbit