Skip to content

docs(site): document all schedule expression types in schedule-syntax guide#717

Merged
jamesadevine merged 1 commit into
mainfrom
docs/schedule-syntax-completeness-a1804d49abbc6a12
May 23, 2026
Merged

docs(site): document all schedule expression types in schedule-syntax guide#717
jamesadevine merged 1 commit into
mainfrom
docs/schedule-syntax-completeness-a1804d49abbc6a12

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • Expands the schedule-syntax guide to cover all supported schedule forms, which were previously undocumented on the site: hourly, bi-weekly, tri-weekly, every N days/weeks, minute intervals, bare daily/weekly forms, and 12-hour time format.
  • Adds an important accuracy note that minute intervals are fixed, not scattered — unlike all other schedule types.
  • Documents the valid hour intervals (1, 2, 3, 4, 6, 8, 12 — factors of 24) to help users avoid the compile-time warning.
  • Adds practical example for frequent monitoring with minute intervals.
  • Improves the Tips section to guide users toward the right schedule type for their use case.

Changes

  • site/src/content/docs/guides/schedule-syntax.mdx: reorganized into complete sections covering all schedule variants; added Minute intervals section; added Multi-day and bi-weekly section; added 12-hour time format note; updated scattering section to note the fixed-interval exception; improved tips.

Accuracy checks

  • hourly: confirmed in src/fuzzy_schedule.rs module doc comment and FuzzySchedule::Hourly variant.
  • bi-weekly / tri-weekly: confirmed via FuzzySchedule::BiWeekly/TriWeekly and parser at lines 279–287.
  • every N days / every N weeks: confirmed via FuzzySchedule::EveryDays and create_interval_schedule at line 492/498.
  • Minute intervals fixed (not scattered): confirmed via FuzzySchedule::EveryMinutes doc comment "fixed, not scattered".
  • Valid hour intervals (1,2,3,4,6,8,12): confirmed by warning message in create_interval_schedule at line 471.
  • Minimum 5-minute interval: confirmed at line 486.
  • 12-hour time format (3pm, 11am, midnight, noon): confirmed in parse_time_spec at lines 150–192.

Validation

  • cd site && npm ci && npm run build — 29 pages built, all internal links valid.

Created by the docs-writer workflow.

Generated by Docs Writer · ● 23.5M ·

… guide

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 23, 2026
@jamesadevine jamesadevine marked this pull request as ready for review May 23, 2026 14:11
@jamesadevine jamesadevine merged commit b6bc4c7 into main May 23, 2026
@jamesadevine jamesadevine deleted the docs/schedule-syntax-completeness-a1804d49abbc6a12 branch May 23, 2026 14:11
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