Skip to content

docs: fix documentation drift — missing schedule syntax options#480

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-schedule-syntax-drift-033fa91338b6a0a9
May 9, 2026
Merged

docs: fix documentation drift — missing schedule syntax options#480
jamesadevine merged 1 commit into
mainfrom
docs/fix-schedule-syntax-drift-033fa91338b6a0a9

Conversation

@github-actions

@github-actions github-actions Bot commented May 9, 2026

Copy link
Copy Markdown
Contributor

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Schedule syntax bi-weekly, tri-weekly, every N days, and every N weeks are fully implemented in src/fuzzy_schedule.rs and documented in docs/schedule-syntax.md, but missing from README.md README.md
Schedule syntax The frequency table is missing every N days and every N weeks options; valid hour intervals described as "must divide 24" rather than listing the actual valid set prompts/create-ado-agentic-workflow.md

Details

src/fuzzy_schedule.rs implements and tests the following schedule variants:

  • EveryDays(u8)every 2 days, every 3 days, etc.
  • every N weeks — accepted input, converted to EveryDays(N*7)
  • BiWeeklybi-weekly / biweekly (every 14 days)
  • TriWeeklytri-weekly / triweekly (every 21 days)
  • Valid hour intervals: [1, 2, 3, 4, 6, 8, 12] (all confirmed in code at line 468)

docs/schedule-syntax.md correctly documents all of these (lines 61–63).

README.md schedule 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 the bi-weekly/tri-weekly rows but was missing every N days and every 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

  • Added every 2 days, every 2 weeks, bi-weekly, tri-weekly examples to README.md schedule syntax block
  • Clarified valid hour intervals in README.md comment (valid: 1, 2, 3, 4, 6, 8, 12)
  • Added every 2 days and every 2 weeks rows to the frequency options table in prompts/create-ado-agentic-workflow.md
  • Clarified valid hour intervals in the prompts frequency table

This pull request was created by the automated documentation freshness check.

Generated by Documentation Freshness Check · ● 4.9M ·

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 jamesadevine marked this pull request as ready for review May 9, 2026 07:01
@jamesadevine jamesadevine merged commit 2cd5935 into main May 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant