Developer
Debug Kunai with evidence, run live provider checks responsibly, and keep documentation aligned with the CLI.
Contributor docs
Evidence-first debugging, responsible live-provider checks, and documentation that stays aligned with the CLI.
Assume you can run Kunai from source, read traces, and tell manual live smokes apart from automated unit tests.
Live provider traffic is manual
Provider scrapers hit real third-party endpoints. Live checks belong in explicit smoke scripts and local debugging — not in docs builds, CI, or background jobs triggered by reading documentation.
Guides
Contributors
Work on Kunai safely
Evidence-first debugging, explicit live-provider checks, and docs that stay synced with the CLI.
Debugging Workflow
Triage playback failures, read traces, and run manual live smokes responsibly.
Contribute
Fork, test, open PRs, and run live provider checks only when appropriate.
Docs Maintenance
Add pages, run drift tests, and ship documentation without coupling CLI releases.
Release Checklist
Regenerate codegen metadata and verify the docs gate on each CLI release.
Before you change providers
- Compare against the local ani-cli checkout when touching AllAnime or AllManga parity logic.
- Read
.docs/providers.mdand.docs/provider-intake.mdin the repository clone for hard boundaries (not published on this site). - Capture failing evidence with
--debug-session, reproduce with/diagnostics, export with/export-diagnostics.
Docs toolchain
| Task | Command |
|---|---|
| Sync CLI metadata into docs | bun run --cwd apps/docs generate |
| Typecheck docs app | bun run --cwd apps/docs typecheck |
| Drift + render tests | bun run --cwd apps/docs test |
| Production build | bun run --cwd apps/docs build |
Codegen keeps provider ids, command counts, and help tables aligned with apps/cli — see Docs maintenance for the full workflow.
Last updated on