Skip to content

docs: sync README + CHANGELOG + practice/README with PR #29/#30 features#31

Merged
kengio merged 1 commit into
mainfrom
docs/practice-quiz-feature-sync
May 21, 2026
Merged

docs: sync README + CHANGELOG + practice/README with PR #29/#30 features#31
kengio merged 1 commit into
mainfrom
docs/practice-quiz-feature-sync

Conversation

@kengio
Copy link
Copy Markdown
Owner

@kengio kengio commented May 21, 2026

Summary

Closes the doc-sync gap left by PR #29 / #30. Per the README & CLAUDE.md Sync Rule in CLAUDE.md, the practice-quiz overhaul shipped without updates to the user-visible documentation surfaces.

  • CHANGELOG.md — new entry 2026.05.21-25 covering completion summary, attempt history, export, pause/resume, WCAG AAA. Includes contrast-ratio before/after tables for both themes.
  • practice/README.md — added a Features section listing every user-visible capability; expanded Privacy with the two localStorage key families + summary export; fixed outdated Caveats counts (was 198 + 573; now 364 + 567 = 931).
  • README.md (top-level) — live-link blurb enumerates the new features so casual visitors see them without clicking through.

Test plan

No changes needed for

  • CLAUDE.md — sync table doesn't require updates for adding banks to existing certs
  • i18n/th/STATUS.md — top-level README already ⏳ in scope (no Thai counterpart yet to mark stale); CHANGELOG + CLAUDE are ❌ policy

🤖 Generated with Claude Code

…that shipped in PR #29 / #30

Per the README & CLAUDE.md Sync Rule in CLAUDE.md, the practice-quiz
overhaul that landed in PR #29 (mock exams + summary + history + export +
pause + AAA) shipped without a corresponding doc update for the new
user-facing surfaces. This PR closes that gap.

CHANGELOG.md
- New entry '2026.05.21-25 — Practice quiz: completion summary, attempt
  history, export, pause/resume, WCAG AAA' covering everything that
  rode along with the mock-exam launch but is its own feature surface.
  Includes the AAA contrast-ratio tables (before/after, both themes),
  the actionbar grid layout, the export formats, and the pause/resume
  effort-time accounting.
- Existing '2026.05.21-24' entry stays as the mock-exam launch.

practice/README.md
- New 'Features' section listing every user-visible capability (two-step
  picker, adaptive selector, timer + pause/resume, completion summary,
  attempt history, HTML/CSV export, keyboard map, theme, AAA, mobile).
- 'Privacy' section expanded with the two localStorage key families
  (per-question + completed sessions) and the new summary-export route.
- 'Caveats' counts updated (was '198 + 573'; now '364 + 567 = 931').

README.md
- Top-level live-link blurb expanded from 'Light/dark/auto theme +
  accessible reset' to enumerate the new features so casual visitors
  know what's there without clicking through.

CLAUDE.md
- No change. The sync table doesn't require updates for adding banks
  to existing certs, and the one-line tree-diagram comment for
  'practice/' is still accurate at that level of abstraction.

i18n/th/STATUS.md
- No change. Top-level README.md is already tracked as ⏳ (not yet
  translated, so no Thai counterpart to mark stale). CHANGELOG.md and
  CLAUDE.md are ❌ policy (never translated). practice/README.md isn't
  in the Thai scope.
@kengio kengio merged commit 78104bb into main May 21, 2026
1 of 2 checks passed
@kengio kengio deleted the docs/practice-quiz-feature-sync branch May 21, 2026 17:33
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