Skip to content

docs: consistency pass across guides and readme#28

Merged
jdwit merged 1 commit into
mainfrom
docs/consistency-pass
Jun 13, 2026
Merged

docs: consistency pass across guides and readme#28
jdwit merged 1 commit into
mainfrom
docs/consistency-pass

Conversation

@jdwit

@jdwit jdwit commented Jun 13, 2026

Copy link
Copy Markdown
Owner

A pass over the docs to bring them back in line with the current CLI surface (verified against the live typer reference output) and to clean up a few inconsistencies.

Changes

  • playlists.md: renamed the Power moves section to Recipes; reframed the first example from a "watch later" curation (Watch Later is a special system playlist, not a search-curated one) to building a themed playlist; replaced the <new-banger> placeholder with <video-id>.
  • README.md: fixed the CI badge, which pointed at jdwit/ytstudio instead of the actual jdwit/ytstudio-cli repo; dropped the "reply" claim from the comments feature line (there is no comments reply command; the surface is list/publish/reject/--ban). Also includes the earlier removal of the redundant "Power-user moves" block.
  • analytics.md: corrected the Quota note. The previous text claimed analytics costs "1 unit per call against the Data API quota", but analytics runs against the separate YouTube Analytics API (its own query-cost quota), as already stated in api-quota.md.
  • index.md: added Playlists to the homepage Highlights and the intro sentence; it shipped recently and was already in the nav and README features but missing here.
  • videos.md: surfaced videos categories in the "List and inspect" block so the command is discoverable (it was only referenced inline in the sidecar section).

mkdocs build passes with no warnings of our own.

- playlists: rename 'power moves' to 'recipes', fix watch-later and
  video-id placeholder examples
- readme: fix ci badge repo url (ytstudio -> ytstudio-cli), drop
  nonexistent comments 'reply' feature
- analytics: correct quota note (analytics api is separate from the
  data api quota)
- index: add playlists to highlights and the intro line
- videos: surface 'videos categories' in list and inspect
@jdwit jdwit merged commit d91a37f into main Jun 13, 2026
7 checks passed
@jdwit jdwit deleted the docs/consistency-pass branch June 13, 2026 08:24
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