KB Maintenance
Keep the knowledge base current through automated polling and health checks.
Quick Start
- •Poll feeds:
python3 .github/skills/kb-maintenance/scripts/poll_sources.py [--dry-run] - •Check links:
python3 .github/skills/kb-maintenance/scripts/check_link_health.py [--dry-run] [--sample N] - •Review delta report and fix broken links
- •Update
kb/SOURCES.yamlandkb/CURRENT_STATE_SNAPSHOT.md
Inputs
- •kb/SOURCES.yaml: Primary data source (canonical URLs and feeds)
- •kb/CURRENT_STATE_SNAPSHOT.md: Current state documentation
Output
- •Delta report: what's new since last poll
- •Health report: broken links, redirects, status changes
- •Updated SOURCES.yaml (if fixes needed)
Core Workflow
Monthly Maintenance Cycle
- •Poll feeds - Read SOURCES.yaml
update_feeds, fetch RSS/Atom/API endpoints, identify new entries sincelast_checkeddate - •Check link health - Validate
canonical_urlsandlatest_known.reference_url, report dead links and redirects - •Generate delta report - What's new, what's broken, what needs manual review
- •Update sources - Fix broken URLs, update
last_checked, add new sources if discovered - •Update snapshot - Refresh
CURRENT_STATE_SNAPSHOT.mdwith current state
Feed Types
| Type | How to Poll | Example |
|---|---|---|
| RSS/Atom | Fetch XML, parse entries after last_checked | GitHub Blog RSS |
| API | Fetch JSON, filter by date | JetBrains plugin API |
| none | Manual check required | Docs pages (no feed) |
See maintenance-procedure.md for full workflow details.
Scripts
- •poll_sources.py - Poll RSS/Atom feeds, emit delta report
- •check_link_health.py - Validate URLs, emit health report
Reference
- •Maintenance Procedure - Monthly workflow, feed types, cadence
Done When
- • Feed polling completed (or --dry-run passed)
- • Link health check completed (or --dry-run passed)
- • Delta report generated
- • Broken links documented
- • SOURCES.yaml updated with
last_checkeddates