Skip to content

README: lead with a demo video and review the page - #28

Merged
andrepaim merged 2 commits into
masterfrom
docs/readme-demo-video
Nov 16, 2026
Merged

andrepaim merged 2 commits into
masterfrom
docs/readme-demo-video

Conversation

@andrepaim

@andrepaim andrepaim commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

The README now leads with a demo video instead of the screenshot showcase, and the rest of the page was reviewed against the repository.

The video is a GitHub attachment uploaded by the owner; its SHA-256 matches the reviewed render, and GitHub's renderer turns the README line into a video player.

Changes

  • Demo video replaces the screenshots. "See pdfpal in action" is now the video, one line on how it was recorded, and a table of what it shows (Find, Ask, Visualize, Keep, Share, Connect), each linked to its feature section. All twelve embedded stills are gone from the README, including the collapsed gallery and the backups image.
  • Sharing section moved to a guide. The eight dense paragraphs under "Share a highlight as a post" are now docs/share-posts.md, under headings, and the README keeps a short summary ("Share what you read"). The text is moved as written, with one fix: "Save all slides (ZIP) and Save as PDF save all three" was wrong for paper and multi-highlight carousels, so it now says "every card". The docs index links the guide.
  • Linux preview download. The README pointed at the separate linux-desktop-v2.8.0-beta.5.linux.1 preview and said Linux is published separately. Releases desktop-v2.8.0-beta.6 and -beta.7 ship Windows and Linux together, as docs/windows-release-pipeline.md and docs/linux-quickstart.md already say, so the README now points at the newest desktop release.
  • Project loops removed. LOOPS.md was deleted in 263f0ae, which left a broken link; npm run check:docs fails on master because of it.
  • Capture notes. screenshots/CAPTURE.md gains a section on the video: what is real, the sample library, what the recording adds (a drawn pointer, hidden scrollbars), and how it was edited (cuts, zooms, shortened waits, one segment with approximate pacing).

Not changed

  • The still images, capture-readme.ts and capture-manifest.json stay in the repository. CAPTURE.md treats them as retained, reproducible evidence, so removing them is a separate decision.
  • No application code, tests, versions or workflows.

Checks

  • npm run check:docs: 195 local links in 50 Markdown files, no errors (it failed before this change on the LOOPS.md link).
  • node scripts/check-secrets.mjs passes.
  • The video was recorded against an isolated library with public arXiv papers; nothing from a personal library or account appears.

🤖 Generated with Claude Code

- Replace the screenshot showcase with a demo video (link added before
  merge) and a table of what it shows. The stills stay in screenshots/
  with their capture tooling; CAPTURE.md records how the video was made.
- Move the long sharing section into docs/share-posts.md and summarise
  it in the README. The text is moved as written, apart from "save all
  three", which was wrong for carousels of more than three cards.
- Linux preview: point at the coordinated desktop release instead of the
  older separate preview, and drop the sentence saying Linux is published
  separately.
- Remove the Project loops section: LOOPS.md was deleted, so its link was
  broken and `npm run check:docs` failed on master.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@andrepaim

Copy link
Copy Markdown
Owner Author
pdfpal-demo.mp4

Replaces the placeholder with the uploaded GitHub attachment.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@andrepaim
andrepaim marked this pull request as ready for review November 16, 2026 19:56
@andrepaim
andrepaim merged commit 94afe82 into master Nov 16, 2026
7 checks passed
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