docs: fix documentation drift — missing schedule syntax options#480
Merged
jamesadevine merged 1 commit intoMay 9, 2026
Merged
Conversation
Add missing schedule options to README.md and prompts/create-ado-agentic-workflow.md: - every N days (EveryDays variant in fuzzy_schedule.rs) - every N weeks (converts to N×7 days) - bi-weekly / tri-weekly (already in prompts table but missing from README) - Clarify valid hour intervals: 1, 2, 3, 4, 6, 8, 12 (not just "must divide 24") All options are implemented in src/fuzzy_schedule.rs and documented in docs/schedule-syntax.md, but were missing from the human-facing README and the AI agent prompts guide. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jamesadevine
approved these changes
May 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
bi-weekly,tri-weekly,every N days, andevery N weeksare fully implemented insrc/fuzzy_schedule.rsand documented indocs/schedule-syntax.md, but missing fromREADME.mdREADME.mdevery N daysandevery N weeksoptions; valid hour intervals described as "must divide 24" rather than listing the actual valid setprompts/create-ado-agentic-workflow.mdDetails
src/fuzzy_schedule.rsimplements and tests the following schedule variants:EveryDays(u8)—every 2 days,every 3 days, etc.every N weeks— accepted input, converted toEveryDays(N*7)BiWeekly—bi-weekly/biweekly(every 14 days)TriWeekly—tri-weekly/triweekly(every 21 days)[1, 2, 3, 4, 6, 8, 12](all confirmed in code at line 468)docs/schedule-syntax.mdcorrectly documents all of these (lines 61–63).README.mdschedule syntax block was missing the multi-day/special-period variants entirely.prompts/create-ado-agentic-workflow.md(the primary guide AI agents use to create workflows) had thebi-weekly/tri-weeklyrows but was missingevery N daysandevery N weeks. The "must divide 24" wording for hour intervals was also imprecise — the actual constraint is a fixed set[1, 2, 3, 4, 6, 8, 12].Applied Fixes
every 2 days,every 2 weeks,bi-weekly,tri-weeklyexamples toREADME.mdschedule syntax blockREADME.mdcomment (valid: 1, 2, 3, 4, 6, 8, 12)every 2 daysandevery 2 weeksrows to the frequency options table inprompts/create-ado-agentic-workflow.mdThis pull request was created by the automated documentation freshness check.