Agent skill
ensure-docs
Verify documentation coverage and generate missing docs interactively
Install this agent skill to your Project
npx add-skill https://github.com/existential-birds/beagle/tree/main/plugins/beagle-docs/skills/ensure-docs
SKILL.md
Ensure Documentation Coverage
Verify documentation coverage across a codebase, report gaps, and generate missing docs with parallel language-specific agents.
Workflow
- Detect languages present in the target codebase.
- Review the detailed workflow and standards in
references/workflow.md. - Spawn parallel verification agents for each detected language.
- Consolidate findings into a single report.
- Offer interactive generation for any gaps the user wants to fix.
- Verify generated docs with the appropriate linters.
Notes
- Use
--report-onlyto skip generation. - Avoid test files unless they are test helpers.
- Keep report output aligned with the language-specific standards in the reference file.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
review-python
Comprehensive Python/FastAPI backend code review with optional parallel agents
review-verification-protocol
Mandatory verification steps for all code reviews to reduce false positives. Load this skill before reporting ANY code review findings.
sqlalchemy-code-review
Reviews SQLAlchemy code for session management, relationships, N+1 queries, and migration patterns. Use when reviewing SQLAlchemy 2.0 code, checking session lifecycle, relationship() usage, or Alembic migrations.
fastapi-code-review
Reviews FastAPI code for routing patterns, dependency injection, validation, and async handlers. Use when reviewing FastAPI apps, checking APIRouter setup, Depends() usage, or response models.
pytest-code-review
Reviews pytest test code for async patterns, fixtures, parametrize, and mocking. Use when reviewing test_*.py files, checking async test functions, fixture usage, or mock patterns.
postgres-code-review
Reviews PostgreSQL code for indexing strategies, JSONB operations, connection pooling, and transaction safety. Use when reviewing SQL queries, database schemas, JSONB usage, or connection management.
Didn't find tool you were looking for?