Skip to content

[docs] docs: reduce bloat in schedule-syntax.md (56.6% reduction)#11199

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-schedule-syntax-27da8f2da08b2fa1
Jan 22, 2026
Merged

[docs] docs: reduce bloat in schedule-syntax.md (56.6% reduction)#11199
pelikhan merged 1 commit intomainfrom
docs/unbloat-schedule-syntax-27da8f2da08b2fa1

Conversation

@github-actions
Copy link
Contributor

Summary

Reduced bloat in the Schedule Syntax reference documentation from 657 to 285 lines, achieving a 56.6% reduction (372 lines removed) while preserving all essential technical information.

Changes Made

Consolidated Repetitive Examples

  • Combined multiple similar code blocks into single examples with inline comments
  • Example: Daily schedules with time constraints reduced from 5 separate blocks to 1 comprehensive block

Removed Verbose Patterns

  • Eliminated repetitive "Use cases:", "Output:", and "How it works:" sections
  • Removed excessive explanatory text that restated what code examples already showed clearly

Streamlined Sections

  • Time Formats: Condensed from 40 lines to 14 lines
  • Interval Schedules: Consolidated from 105 lines to 31 lines
  • UTC Offset Support: Reduced from 36 lines to 10 lines
  • Weekly Schedules: Simplified from 30 lines to 9 lines
  • Best Practices: Merged duplicate content and removed redundancy

Preserved All Technical Content

  • All schedule syntax patterns remain documented
  • All examples remain functional and accurate
  • All warnings and tips preserved
  • All supported intervals and formats listed

Impact

The documentation is now:

  • More scannable: Key information visible at a glance
  • Less repetitive: Each concept explained once, clearly
  • Equally complete: All technical details preserved
  • More maintainable: Less duplication means easier updates

File Statistics

  • Before: 657 lines
  • After: 285 lines
  • Reduction: 372 lines removed (56.6%)

Screenshot Issues

Note: Unable to capture screenshots due to network restrictions in the CI environment. The Playwright MCP tool encountered:

  • ERR_CONNECTION_REFUSED when accessing localhost
  • ERR_BLOCKED_BY_CLIENT when accessing external sites

This appears to be a limitation of the sandboxed environment. The documentation builds successfully and can be previewed locally with npm run preview.

Verification

To verify the changes locally:

cd docs
npm run build
npm run preview
# Visit http://localhost:4321/gh-aw/reference/schedule-syntax/

AI generated by Documentation Unbloat

Consolidated repetitive examples and removed excessive verbosity in the schedule syntax reference documentation.

Changes:
- Reduced file from 657 to 285 lines (372 lines removed, 56.6% reduction)
- Consolidated multiple similar code examples into single blocks with inline comments
- Removed repetitive "Use cases:", "Output:", and "How it works:" sections
- Simplified verbose explanations while preserving all technical information
- Condensed time format examples into a single comprehensive block
- Merged duplicate best practices content
- Streamlined scattering algorithm explanation

The documentation now provides the same information in a more concise, scannable format.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Jan 22, 2026
@pelikhan pelikhan marked this pull request as ready for review January 22, 2026 06:30
@pelikhan pelikhan merged commit 3ad4c92 into main Jan 22, 2026
@pelikhan pelikhan deleted the docs/unbloat-schedule-syntax-27da8f2da08b2fa1 branch January 22, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants