Skip to content

πŸ“ Documentation drift detected β€” schedule syntax incomplete in README and workflow promptΒ #245

@github-actions

Description

@github-actions

Documentation Freshness Audit

The weekly documentation audit found the following inconsistencies between the codebase and documentation:

Findings

Area Issue File(s)
Schedule Syntax bi-weekly, tri-weekly, and every N days/every N weeks missing entirely README.md
Schedule Syntax every N days and every N weeks interval expressions missing from Step 3 table prompts/create-ado-agentic-workflow.md

Details

1. README.md β€” Schedule Syntax section is incomplete

The ## Schedule Syntax section (around line 257) only documents these patterns:

schedule: daily
schedule: daily around 14:00
schedule: daily between 9:00 and 17:00
schedule: weekly on monday around 9:00
schedule: hourly
schedule: every 2h
schedule: every 15 minutes

Three schedule categories are entirely absent:

  • bi-weekly β€” FuzzySchedule::BiWeekly (every 14 days), accepted as "bi-weekly" or "biweekly" in src/fuzzy_schedule.rs:279
  • tri-weekly β€” FuzzySchedule::TriWeekly (every 21 days), accepted as "tri-weekly" or "triweekly" in src/fuzzy_schedule.rs:285
  • every N days / every N weeks β€” FuzzySchedule::EveryDays(n), handled by parse_interval_schedule in src/fuzzy_schedule.rs:492,498 with unit aliases days, day, d, weeks, week, w

These are all documented in AGENTS.md (under "Special Periods" in the Schedule Syntax section) and tested in src/fuzzy_schedule.rs:903-915, but are completely absent from README.md.

2. prompts/create-ado-agentic-workflow.md β€” Step 3 schedule table is missing every N days/every N weeks

The Step 3 frequency table (around line 104) correctly lists bi-weekly and tri-weekly but omits the general-purpose every N days and every N weeks interval forms:

Expression Meaning
bi-weekly Every 14 days
tri-weekly Every 21 days

Missing entries:

Expression Meaning
every 2 days / every 3d Every N days at scattered time
every 2 weeks / every 2w Every N weeks at scattered time

Since AI agents use this prompt to generate workflow files, they won't know to use every 2 days or every 2w β€” they'll either use bi-weekly/tri-weekly (for only 14 or 21 days) or be unable to express arbitrary day/week intervals.

The parse_interval_schedule function in src/fuzzy_schedule.rs:404 accepts days/day/d and weeks/week/w units β€” e.g., every 3 days, every 2w, every 4d.

Suggested Fixes

  • README.md: Add bi-weekly, tri-weekly, and every N days/every N weeks to the Schedule Syntax section, mirroring the "Special Periods" block from AGENTS.md
  • prompts/create-ado-agentic-workflow.md: Add every 2 days / every 3d and every 2 weeks / every 2w rows to the Step 3 frequency table

This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check Β· ● 2.3M Β· β—·

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions