Documentation: record decisions, update integration guide and README #37

Manually merged
marvin8 merged 1 commit from feat/issue-30-documentation into main 2026-08-20 04:25:52 +00:00
Collaborator

Closes #30

Documentation batch:

  • concept.md — the three open questions are now recorded as resolved decisions: CLI-only, opml.xml in scope, and a standalone cron/wrapper trigger (not a ytdl-sub post-download hook). The "static file" section's hook mention is updated to match.
  • docs/ytdl-sub-integration.md — per-episode thumbnails are no longer "reserved for future use"; they're emitted as episode-level <itunes:image>.
  • README.md — added a Troubleshooting section and an example feed.xml snippet.
  • feed.pyformat_pub_date's docstring now documents the midnight-UTC design decision.
  • improvements.md — marked the completed items done (including the #29 test-coverage items and the pre-existing CI-skip documentation).
Closes #30 Documentation batch: - **`concept.md`** — the three open questions are now recorded as resolved decisions: CLI-only, `opml.xml` in scope, and a standalone cron/wrapper trigger (not a ytdl-sub post-download hook). The "static file" section's hook mention is updated to match. - **`docs/ytdl-sub-integration.md`** — per-episode thumbnails are no longer "reserved for future use"; they're emitted as episode-level `<itunes:image>`. - **`README.md`** — added a Troubleshooting section and an example `feed.xml` snippet. - **`feed.py`** — `format_pub_date`'s docstring now documents the midnight-UTC design decision. - **`improvements.md`** — marked the completed items done (including the #29 test-coverage items and the pre-existing CI-skip documentation).
📝 docs: record concept decisions, update integration guide, add README example and troubleshooting
All checks were successful
/ gitleaks (pull_request) Successful in 16s
/ checks (pull_request) Successful in 1m45s
/ publish (pull_request) Has been skipped
/ deploy-docs (pull_request) Has been skipped
/ pr-review (pull_request) Successful in 2m31s
3c62a2eab9
marvin8 approved these changes 2026-08-20 04:25:25 +00:00
marvin8 manually merged commit 9888a06df2 into main 2026-08-20 04:25:52 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
marvin8/sub2pod!37
No description provided.