docs: sync the reference docs, skills and metadata with the shipped code#209
Merged
Merged
Conversation
- animation-rendering.md describes the real WAAPI engine (useStrokeReveal, two-thirds-law keyframes, isochrony, pen pause) instead of the CSS- keyframes/constant-speed design it replaced; the width-resolver sketch uses the real property and the /write payload path. - open-pr skill learns CI's third job (migrations) + /verify-migrations precondition. - CITATION.cff bumped to 0.13.0/2026-07-09; the CHANGELOG header makes the bump part of every release cut. - quiz-wortbank.md ratio corrected to the counted 75/25; docs/index.md carries the full (style, glyph, position, variant) tuple and a current status line; frontend-stack.md route map stops claiming a live-written hero; design-system.md documents paper.viridianText + its usage rule; planaenderungen.md Vorschlag D gets a shipped-precursor status note. - CHANGELOG [Unreleased] regrouped to one heading per category; orphaned design artifacts removed from docs/reference. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159fD7DbqAfV4emrk2mcsDH
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR audits and updates documentation/metadata to match the shipped implementation (no runtime code changes), reducing doc↔code drift across the animation renderer, CI/skills guidance, and project metadata.
Changes:
- Update reference docs to describe the shipped WAAPI-based stroke reveal engine and the real width-resolver plumbing.
- Refresh project metadata and release process guidance (CITATION version/date; CHANGELOG release note).
- Remove orphaned/duplicate reference artifacts and correct small drift details (quiz word-bank ratio, route descriptions, library tuple).
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/quiz-wortbank.md | Updates the counted modern/historic ratio and total word count. |
| docs/reference/kurrentschrift-landing.html | Removes an orphaned pre-design-system landing mockup (large embedded assets). |
| docs/reference/frontend-stack.md | Corrects the landing route description to match the shipped “font-first” hero. |
| docs/reference/animation-rendering.md | Rewrites animation rendering doc around the shipped WAAPI + strokeTiming approach and /write payload path. |
| docs/proposals/planaenderungen.md | Adds a July 2026 status note tying the proposal to the shipped core/shaping.py precursor. |
| docs/index.md | Updates current MVP status and documents the full library tuple (style, glyph, position, variant). |
| docs/concepts/design-system.md | Documents the shipped paper.viridianText token and its usage rule. |
| CITATION.cff | Bumps citation version/date to match the current release. |
| CHANGELOG.md | Updates release procedure note (include CITATION bump) and regroups [Unreleased] headings. |
| .claude/skills/open-pr/SKILL.md | Updates pipeline-watch guidance to include CI’s migrations job and local verification expectation. |
…orschlag-D column note The animation sketch now defines `steps` like the real hook does, and the planaenderungen terminology note says plainly that templates.position is the shipped column while the chart_role rename stays hypothetical. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159fD7DbqAfV4emrk2mcsDH
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159fD7DbqAfV4emrk2mcsDH
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit package 5 of 6: the doc↔code drift findings — no code changes.
What
animation-rendering.md§1 rewritten around the shipped engine. It claimed "CSS-Keyframes (Emotion), nicht WAAPI" with constant pen speed; the real implementation is the opposite — WAAPI (useStrokeReveal.ts/el.animate), deliberately not global Emotion keyframes (live typing on /federprobe would grow the stylesheet unboundedly), with two-thirds-law non-linear dashoffset keyframes + isochrony fromlib/strokeTiming.tsand a pen pause before lifted strokes. The §3 sketch now uses the realstyles.width_resolver == "constant"property (was a nonexistent German-valuedwidth_profile_mode) and points at the/writepayload path instead of/diagnostic./open-prskill knows CI's third job. The pipeline-watch step listed two jobs; theMigrations (alembic upgrade head)job added in Audit packages 5+6: docs/skills refresh + CI hardening (incl. a real drift fix found by alembic check) #204 was invisible to the mandatory PR loop. Also names/verify-migrationsas the local precondition for alembic diffs.CITATION.cffcatches up (0.1.0/2026-06-10 → 0.13.0/2026-07-09) and the CHANGELOG header makes the CITATION bump part of every release cut so it can't drift again.quiz-wortbank.mdratio corrected to the counted 75/25 modern/historic (was 60/40);docs/index.mdnames the full library tuple(style, glyph, position, variant)and gets a current status line;frontend-stack.md's route map stops claiming the hero writes live (font-first per design-system §7);design-system.md's binding colour table gains the shippedpaper.viridianTexttoken + the "viridian as text" usage rule;planaenderungen.mdVorschlag D gets a status note (core/shaping.pyis the shipped precursor; the proposal'sglyphstable has beentemplatessince migration 0004).[Unreleased]regrouped to one heading per category (duplicate### Changed/### Fixedfrom successive PR insertions would have made the next release cut error-prone).docs/reference/: the pre-design-system landing mockupkurrentschrift-landing.htmland the duplicategl-germancursive.woff2(live copy:app/src/assets/fonts/).Verification
uv run --extra test pytest: 377 passed; ruff cleanapp/,api/,core/oralembic/changes — docs, skills and metadata only🤖 Generated with Claude Code
https://claude.ai/code/session_0159fD7DbqAfV4emrk2mcsDH
Generated by Claude Code