Skip to content

docs: chapters also come from an episode's MP3 file - #523

Merged
chhoumann merged 1 commit into
masterfrom
docs/id3-chapters
Oct 24, 2026
Merged

chhoumann merged 1 commit into
masterfrom
docs/id3-chapters

Conversation

@chhoumann

@chhoumann chhoumann commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Summary

2.23.0 shipped ID3 chapters (#521, #512). The docs said chapters come only from the feed's chapters file. This updates the Chapters panel in player.md and {{chapters}} in templates.md: a feed chapters file still wins, else PodNotes reads the chapters embedded in a streamed MP3, asking for only the start of the file, and after a restart only once you select Play. Vault files get no chapters this way.

Verification

  • npm run docs:build passes (22 pages, all 112 legacy fragments resolve).
  • Claims checked against src/utility/fetchChapters.ts, src/utility/id3Chapters.ts, and src/createPodcastNote.ts at 2.23.0, and in Obsidian 1.14.4 on Linux: Efervesciencia episode 756 (https://www.spreaker.com/show/2892576/episodes/feed) showed its 4 MP3 chapters in the Chapters panel and in {{chapters}}.

Release impact

None. Docs only.


Note

Low Risk
Documentation-only updates with no code or runtime behavior changes.

Overview
Documents MP3-embedded chapters alongside the existing feed chapters file, matching behavior shipped in 2.23.0.

In player.md, the Chapters panel is described as appearing when the episode has chapters (not only when the feed supplies a chapters file). A new subsection explains precedence: feed chapters file first, otherwise ID3 chapters from a streamed MP3 (partial fetch at file start), deferred until Play after restart, and no chapters for vault-local playback.

In templates.md, {{chapters}} is updated the same way: feed <podcast:chapters> first, then embedded MP3 chapters for streamed feed episodes; empty output on failed requests or when no chapters exist (replacing wording that only mentioned an empty chapters file).

Reviewed by Cursor Bugbot for commit 6e56684. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Document that chapters also come from an episode's MP3 file

  • Updates player.md to state that the chapter panel appears when an episode has chapters, not only when its feed provides them. Chapters are read from a feed-provided file when available, otherwise from chapters embedded in the streamed MP3, fetched by requesting only the file start
  • Notes that after a restart, playback waits for an explicit Play action, and vault episodes do not get chapters through the MP3 fallback
  • Updates templates.md to describe the MP3 fallback for the chapters template. An episode without chapters, or a failed request, produces an empty value

Macroscope summarized 6e56684.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Deploying podnotes with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6e56684
Status: ✅  Deploy successful!
Preview URL: https://09befe9f.podnotes.pages.dev
Branch Preview URL: https://docs-id3-chapters.podnotes.pages.dev

View logs

@chhoumann
chhoumann merged commit 3593c78 into master Oct 24, 2026
20 checks passed
@chhoumann
chhoumann deleted the docs/id3-chapters branch October 24, 2026 21:23
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