Repository navigation
docs: add the animated note demo to the README - #99
Merged
Merged
Conversation
"What a Note Looks Like" now opens with an animated WebP (English and Chinese) that walks down a real DeepPaperNote note for Attention Is All You Need: the prompt and PDF scan, the opening, the full method with figures, formula and tables, the evidence and analysis, the closing sections, and the note joining a knowledge graph. Each stop carries an in-page tag naming what it shows. The folder tree example now uses the same paper, and vault image names are corrected to the lowercase labels the save script writes (`figure_1.png`), in both READMEs and the changelog. The retired usage-example.png and hero-academic.svg leave the repository; they and the demo's HTML source and render tools stay local, ignored by git. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Summary
The animation walks a camera down one note page:
Each stop has an in-page tag ("Original figures, right in the text", "Numbers straight from the paper", …). Text, figures and tables come from real notes generated on 2026-11-08 with the installed develop skill (Codex, isolated empty vaults), lightly trimmed. The In Your Vault links and the graph are illustrative; the English domain is shown as
NLP(the run filed it undermachine-learning).Why WebP, not GIF: GIF's 256 colors blurred the text (10.6 MB at 960 px). Lossy WebP at 1440 px is sharp on retina. Keyframes every 2–3 frames (
-kmin 2 -kmax 3) remove ghosting: with default spacing, faded-out pixels on the dark background persisted until the next keyframe.Image names: #69 names vault images
figure_1.png(lowercase label); the README and changelog saidFigure_1.png.Evidence
Figure_1.png, which the save script never writes.After: both READMEs embed their language's WebP; names match
plan_figure_table_decisions.pyoutput (figure_1.png,table_2.png).-kmin 2 -kmax 3.python3 -m pytest -q -n auto: 1739 passed, 1 skipped.python3 -m ruff check skills tests: clean.Merge Danger
Door: two-way
Blast Radius: docs
Adds ~20 MB of binaries to history; README first load fetches ~10 MB.
usage-example.pngstays on main until the release merge, where the main README still uses it.🤖 Generated with Claude Code