Skip to content

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

@github-actions

Description

@github-actions

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

  • Add every N days row to the Step 3 frequency table in prompts/create-ado-agentic-workflow.md:
    | `every 2 days` / `every 3d` | Every N days, scattered time |
    
  • (Optional) Add every N weeks row to the same table (e.g. every 2 weeks, equivalent to bi-weekly)
  • Add bi-weekly, tri-weekly, and every 2 days examples to the schedule code block in README.md:
    # Multi-day / multi-week
    schedule: bi-weekly                      # Every 14 days, scattered time
    schedule: tri-weekly                     # Every 21 days, scattered time
    schedule: every 2 days                   # Every N days, scattered time

This issue was created by the automated documentation freshness check.

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

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