Skip to content

docs: add missing MangaBaka config section and fix README drift - #100

Merged
bigspawn merged 2 commits into
mainfrom
docs/readme-mangabaka-config
Sep 16, 2026
Merged

bigspawn merged 2 commits into
mainfrom
docs/readme-mangabaka-config

Conversation

@bigspawn

Copy link
Copy Markdown
Owner

Why

MangaBaka (#97) was added to the README flag table and env var list, but not to either YAML example (README config.yaml block, config.example.yaml). The strategy chains also called it "enabled by default", while its default is false. The existing docs test only checks the flag table and env var list, so neither mistake failed CI.

What

  • Add the mangabaka_api section to both YAML examples and fix the default wording in the strategy chains and notes.
  • Fix other README statements that disagree with the code:
    • legacy CLIENT_SECRET_* env vars only work together with a config file
    • OAUTH_PORT falls back to PORT
    • favorites log lines include the media type
    • only four env vars are validated (Troubleshooting listed six)
    • the Features list now names Hato, MangaBaka and Jikan and the cron watch mode
  • docs_test.go: check that every source in mappingSources() has a section in both YAML examples with the right enabled value, and that README prose uses the right "enabled/disabled by default". Both checks failed before the docs fix.
  • CLAUDE.md: add the YAML examples and chain wording to the checklist for adding a source.

…rom code

MangaBaka shipped without a section in either YAML example and was described as enabled by default while it is off. Also fixes other statements that disagree with the code: legacy CLIENT_SECRET_* only work with a config file, OAUTH_PORT falls back to PORT, favorites log lines name the media type, and only four env vars are validated.
…e registry

The existing docs test only covered the flag table and env var list, so a source missing from both YAML examples or described with the wrong default passed CI. The new checks derive the YAML key from the Config struct tag, so a future source cannot be forgotten silently.
@bigspawn bigspawn self-assigned this Sep 16, 2026
@bigspawn
bigspawn merged commit ca37574 into main Sep 16, 2026
4 checks passed
@bigspawn
bigspawn deleted the docs/readme-mangabaka-config branch September 16, 2026 18:05
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