Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Schedule syntax (prompt) |
every N days and every N weeks intervals missing from frequency table |
prompts/create-ado-agentic-workflow.md |
| Schedule syntax (README) |
bi-weekly, tri-weekly, every N days missing from schedule examples |
README.md |
Details
1. prompts/create-ado-agentic-workflow.md β Frequency table incomplete (Step 3)
The frequency options table in Step 3 currently lists:
| `every 2h` / `every 6h` | Every N hours (must divide 24) |
| `every 15 minutes` | Minimum 5 min interval |
| `bi-weekly` | Every 14 days |
| `tri-weekly` | Every 21 days |
But src/fuzzy_schedule.rs also supports:
every N days / every Nd (e.g. every 2 days, every 3d) β maps to FuzzySchedule::EveryDays(n)
every N weeks / every Nw (e.g. every 2 weeks) β converts weeksβdays via FuzzySchedule::EveryDays(n*7)
docs/schedule-syntax.md (line 56) already documents this correctly:
schedule: every 2 days # Every 2 days at scattered time
This is a high-priority gap: agents authoring new workflows from this prompt won't know these options exist and will over-use bi-weekly/tri-weekly for cases where arbitrary day/week intervals would be more natural.
2. README.md β Schedule section missing several valid forms
The schedule code block in README.md (around line 269β285) only shows:
schedule: hourly # Every hour, scattered minute
schedule: every 2h # Every 2 hours
schedule: every 15 minutes # Fixed, not scattered
But the following are also valid and are supported by src/fuzzy_schedule.rs:
schedule: bi-weekly β every 14 days at scattered time
schedule: tri-weekly β every 21 days at scattered time
schedule: every 2 days β every N days at scattered time
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β 2.7M Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
every N daysandevery N weeksintervals missing from frequency tableprompts/create-ado-agentic-workflow.mdbi-weekly,tri-weekly,every N daysmissing from schedule examplesREADME.mdDetails
1.
prompts/create-ado-agentic-workflow.mdβ Frequency table incomplete (Step 3)The frequency options table in Step 3 currently lists:
But
src/fuzzy_schedule.rsalso supports:every N days/every Nd(e.g.every 2 days,every 3d) β maps toFuzzySchedule::EveryDays(n)every N weeks/every Nw(e.g.every 2 weeks) β converts weeksβdays viaFuzzySchedule::EveryDays(n*7)docs/schedule-syntax.md(line 56) already documents this correctly:This is a high-priority gap: agents authoring new workflows from this prompt won't know these options exist and will over-use
bi-weekly/tri-weeklyfor cases where arbitrary day/week intervals would be more natural.2.
README.mdβ Schedule section missing several valid formsThe schedule code block in
README.md(around line 269β285) only shows:But the following are also valid and are supported by
src/fuzzy_schedule.rs:schedule: bi-weeklyβ every 14 days at scattered timeschedule: tri-weeklyβ every 21 days at scattered timeschedule: every 2 daysβ every N days at scattered timeSuggested Fixes
every N daysrow to the Step 3 frequency table inprompts/create-ado-agentic-workflow.md:every N weeksrow to the same table (e.g.every 2 weeks, equivalent tobi-weekly)bi-weekly,tri-weekly, andevery 2 daysexamples to the schedule code block inREADME.md:This issue was created by the automated documentation freshness check.