Skip to content

Daily Repo Goal Achiever: Fix typos and add Daily Documentation Updater workflow#153

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
daily-repo-goals/phase1-and-phase2-bd6d76483dccfa0c
Draft

Daily Repo Goal Achiever: Fix typos and add Daily Documentation Updater workflow#153
github-actions[bot] wants to merge 1 commit intomainfrom
daily-repo-goals/phase1-and-phase2-bd6d76483dccfa0c

Conversation

@github-actions
Copy link
Contributor

This PR addresses both Phase 1 (consistency checks) and Phase 2 (workflow discovery) of the Daily Repo Goal Achiever task.

Phase 1: Consistency Fixes

Fixed typos and clarity issues found during documentation review:

Issues Fixed

  1. Typo in docs/update-docs.md (line 5)

    • Fixed: [Astro Starlight] (https...[Astro Starlight](https... (removed extra space in markdown link)
  2. Clarity issue in docs/daily-repo-status.md (line 27)

    • Fixed: You can use edit the workflowYou can edit the workflow

These were identified through systematic review of all workflow and documentation files for typos, grammar issues, and clarity problems.

Phase 2: Workflow Discovery - Daily Documentation Updater

Added a new general-purpose workflow from Peli's Agent Factory: Daily Documentation Updater

Source

  • Original: gh-aw/.github/workflows/daily-doc-updater.md
  • Repository: https://github.com/github/gh-aw
  • Blog reference: [Meet the Documentation Workflows]((github.github.io/redacted)

Why This Workflow is Valuable

Perfect for General Use:

  • ✅ No language dependencies (works for any tech stack)
  • ✅ No framework dependencies (adapts to any documentation structure)
  • ✅ Works for ANY repository with documentation
  • ✅ Simple, focused, practical scope
  • 96% merge rate (57/59 PRs merged) - highest success rate among documentation workflows

Business Value:

  • Reduces Documentation Debt: Catches documentation gaps before they accumulate
  • Maintains Quality: Keeps docs synchronized with code changes automatically
  • Saves Time: Automates tedious documentation maintenance
  • Improves UX: Ensures users always have current, accurate documentation
  • Proactive: Updates docs within 24 hours of feature merges

What It Does

  1. Scans merged pull requests from the last 24 hours
  2. Identifies new features, changes, or deprecations
  3. Locates appropriate documentation files
  4. Updates documentation following existing style
  5. Creates a pull request with changes for review
  6. Includes links to original PRs and clear change summaries

Sample Output

A typical run might:

  • Scan last 24 hours, find 3 merged PRs
  • Identify PR Document issue-duplication-detector workflow #123 added a new command-line flag
  • Locate the CLI documentation file
  • Add documentation for the flag with usage examples
  • Create PR: [docs] Update documentation for features from 2026-02-15

Generalization Changes

To make this workflow suitable for the general-purpose agentics collection:

Removed:

  • engine: claude → Changed to engine: copilot (more accessible)
  • strict: true mode (not needed for general use)
  • Imports (shared/mood.md, documentation skill imports)
  • cache-memory: true (simplified)
  • Serena MCP server (Go-specific tool)
  • auto-merge: true (let users decide)
  • Documentation instructions file dependency

Changed:

  • Schedule: cron: daily (more flexible than specific time)
  • Safe outputs: Simplified to PR only
  • Documentation: Enhanced with universal guidance for any repo
  • Category: Added maintenance for better classification
  • Bash commands: Changed from specific list to bash: true (more flexible)

Added:

  • Flexibility to work with any documentation structure
  • Automatic detection of documentation location
  • Guidance for repositories without docs/ directory
  • Support for README-only documentation
  • Generic style matching instead of framework-specific rules

Kept:

  • Core analysis logic
  • GitHub API usage patterns
  • 24-hour scanning window
  • PR creation workflow
  • Practical recommendations

Files Added

  • workflows/daily-doc-updater.md - Workflow definition
  • docs/daily-doc-updater.md - Comprehensive documentation
  • README.md - Added to "Code Improvement Workflows" section

Why Not Other Candidates?

During evaluation, I also considered:

  • Artifacts Summary - Already proposed in PR Daily Repo Goal Achiever: Fix typos and add Artifacts Summary workflow #148
  • Glossary Maintainer (100% merge rate) - Requires Serena (Go tool), too specialized
  • Documentation Unbloat (85% merge rate) - Requires Playwright setup, more complex
  • Duplicate Code Detector (79% merge rate) - Saved for future consideration
  • Go-specific workflows - Not generalizable (go-fan, go-logger, etc.)
  • Campaign workflows - Too complex for general use
  • Organization-level workflows - Require org permissions

Daily Documentation Updater emerged as the best candidate because:

  1. Highest merge rate among generalizable workflows (96%)
  2. Zero special dependencies - works out of the box
  3. Universal applicability - every repo has documentation
  4. Simple to understand - straightforward task and execution
  5. Immediate value - keeps docs synchronized automatically

Use Cases

  1. OSS Projects: Ensure contributors' features are documented promptly
  2. API Projects: Keep API documentation current with code changes
  3. CLI Tools: Document new commands/flags automatically
  4. Libraries: Maintain up-to-date usage examples
  5. Internal Tools: Reduce onboarding friction with current docs

Merge Rate Context

From Peli's Agent Factory blog:

"Daily Documentation Updater has contributed 57 merged PRs out of 59 proposed (96% merge rate), demonstrating exceptional value in keeping documentation synchronized with code changes."

This is one of the highest merge rates across all workflows in the factory, indicating that its documentation updates are consistently valuable and accurate.


Both Phase 1 fixes and Phase 2 workflow addition are included in this single PR to ensure comprehensive repository improvements in one review cycle.

AI generated by [Daily Repo Goal Achiever](https://github.com/githubnext/agentics/actions/runs/${{ github.run_id }})

AI generated by Daily Repo Goal Achiever

…er workflow

Phase 1 - Consistency Fixes:
- Fixed typo in docs/update-docs.md: extra space in Astro Starlight URL
- Fixed typo in docs/daily-repo-status.md: 'You can use edit' → 'You can edit'

Phase 2 - Workflow Discovery:
- Added Daily Documentation Updater workflow from Peli's Agent Factory
- Source: gh-aw/.github/workflows/daily-doc-updater.md
- Merge rate: 96% (57/59 merged PRs)
- Generalized for universal use: removed gh-aw specific dependencies
- Added workflow and documentation files
- Updated README with new workflow entry

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants