Documentation: README, AGENTS.md, integration guide, and concept decisions #30

New issue

Closed

opened 2026-08-19 20:37:58 +00:00 by agent-pi · 1 comment

agent-pi commented

2026-08-19 20:37:58 +00:00

Collaborator

Documentation gaps and stale references:

README has no troubleshooting section and no example feed.xml snippet.
AGENTS.md does not document the expected CI skip behaviour for NAS-dependent tests.
docs/ytdl-sub-integration.md still describes per-episode thumbnails as "reserved for future use" although they are implemented.
The midnight-UTC pubDate design decision is undocumented.
concept.md's open questions are now decided (CLI-only; opml.xml in scope; cron/wrapper trigger rather than a post-download hook) but not recorded.
Lingering CLAUDE.md references in AGENTS.md, CHANGELOG.md, and improvements.md should be renamed to AGENTS.md.

Documentation gaps and stale references: - README has no troubleshooting section and no example `feed.xml` snippet. - AGENTS.md does not document the expected CI skip behaviour for NAS-dependent tests. - `docs/ytdl-sub-integration.md` still describes per-episode thumbnails as "reserved for future use" although they are implemented. - The midnight-UTC `pubDate` design decision is undocumented. - `concept.md`'s open questions are now decided (CLI-only; `opml.xml` in scope; cron/wrapper trigger rather than a post-download hook) but not recorded. - Lingering `CLAUDE.md` references in `AGENTS.md`, `CHANGELOG.md`, and `improvements.md` should be renamed to `AGENTS.md`.

agent-pi commented

2026-08-19 20:38:17 +00:00

Author

Collaborator

Plan of attack:

Record the three decisions in concept.md (open-questions section).
Update docs/ytdl-sub-integration.md — thumbnails are supported.
Add README troubleshooting section and example feed.xml snippet.
Document CI skip behaviour (NAS tests) in AGENTS.md.
Rename remaining CLAUDE.md → AGENTS.md references in AGENTS.md, CHANGELOG.md, improvements.md.
Document the midnight-UTC pubDate decision (AGENTS.md or code comment).

Plan of attack: 1. Record the three decisions in `concept.md` (open-questions section). 2. Update `docs/ytdl-sub-integration.md` — thumbnails are supported. 3. Add README troubleshooting section and example `feed.xml` snippet. 4. Document CI skip behaviour (NAS tests) in `AGENTS.md`. 5. Rename remaining `CLAUDE.md` → `AGENTS.md` references in `AGENTS.md`, `CHANGELOG.md`, `improvements.md`. 6. Document the midnight-UTC `pubDate` decision (AGENTS.md or code comment).

agent-pi referenced this issue

2026-08-19 20:40:34 +00:00

Rename CLAUDE.md references to AGENTS.md #32

agent-pi referenced this issue from a pull request that will close it,

2026-08-20 04:19:55 +00:00

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

agent-pi closed this issue

2026-08-20 10:10:10 +00:00