Skip to content

docs: add the animated note demo to the README - #99

Merged
917Dhj merged 1 commit into
developfrom
docs/readme-demo
Nov 8, 2026
Merged

917Dhj merged 1 commit into
developfrom
docs/readme-demo

Conversation

@917Dhj

@917Dhj 917Dhj commented Nov 8, 2026

Copy link
Copy Markdown
Owner

Summary

 assets/
+├── demo-note.en.webp        # 10.5 MB, 1440×840, ~38 s loop
+├── demo-note.zh-CN.webp     # 10.1 MB
-├── usage-example.png        # AI-generated, garbled text; now local-only
-├── hero-academic.svg        # unreferenced; now local-only
 └── demo/                    # local-only (gitignored): HTML source, paper crops, render tools

 README.md / README.zh-CN.md — What a Note Looks Like
-<!-- Animated demo GIF: added in the assets phase -->
+![A DeepPaperNote deep-reading note for Attention Is All You Need](./assets/demo-note.en.webp)
 folder tree: Segment_Anything → Attention_Is_All_You_Need, Figure_1.png → figure_1.png

 CHANGELOG.md
-such as `Figure_1.png`
+such as `figure_1.png`

The animation walks a camera down one note page:

prompt typed → 3 PDF pages scanned → note page rises
  opening (core info, contributions)
  body: background → method flow → Figure 1 → attention formula → Figure 2 + training
        → results table + source conflict → ablations + claim/evidence table → deep analysis + Table 1
  limitations, takeaways, connections, my notes
  → note joins a knowledge graph; tagline

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 under machine-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 said Figure_1.png.

Evidence

  • Before: README showed a placeholder comment; the tree listed Figure_1.png, which the save script never writes.
    After: both READMEs embed their language's WebP; names match plan_figure_table_decisions.py output (figure_1.png, table_2.png).
  • Ghosting check: a decoded frame from the graph scene, brightened 3×, shows the faded note page under the default encoder settings and a clean background with -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.png stays on main until the release merge, where the main README still uses it.

🤖 Generated with Claude Code

"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>
@917Dhj
917Dhj merged commit bdbeb34 into develop Nov 8, 2026
3 checks passed
@917Dhj
917Dhj deleted the docs/readme-demo branch November 9, 2026 07:58
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