Skip to content

docs: split GitHub Agent workflows into human, event-driven, and scheduled#337

Merged
strawgate merged 1 commit intomainfrom
docs/split-workflow-taxonomy-325-4bc12005a8a19366
Feb 21, 2026
Merged

docs: split GitHub Agent workflows into human, event-driven, and scheduled#337
strawgate merged 1 commit intomainfrom
docs/split-workflow-taxonomy-325-4bc12005a8a19366

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 21, 2026

Summary

  • Reorganized the GitHub Agent workflow docs into three buckets: Human-coordinated, Event-driven, and Scheduled.
  • In docs/workflows/gh-agent-workflows.md, moved auto-triggered issue/PR/check workflows into a new Event-driven section.
  • Kept Scheduled workflows grouped under a parent Scheduled section with Detector / fixer pairs and Standalone scheduled workflows subsections.
  • Updated mkdocs.yml navigation to mirror the same three-way taxonomy and scheduled subsection nesting.

Validation

  • make docs-build fails in strict mode due to a pre-existing missing file: workflows/gh-agent-workflows/agent-efficiency.md (referenced by docs nav/content).

Related

  • Fixes #325

Generated by Update PR Body

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

📝 Walkthrough

Walkthrough

These changes reorganize the GitHub Agent Workflows documentation structure by introducing two new organizational categories—Event-driven workflows and Scheduled workflows—to better categorize workflows by their execution model. Both the documentation content and navigation structure are updated accordingly.

Changes

Cohort / File(s) Summary
Documentation Structure
docs/workflows/gh-agent-workflows.md
Restructured workflow catalog by removing standalone "Detector / fixer pairs" subsection from Human-coordinated section and introducing new top-level "Event-driven workflows" and "Scheduled workflows" groups. Moved workflows between sections and added explanatory text for scheduled detector/fixer pattern.
Navigation Configuration
mkdocs.yml
Reorganized GitHub Agent Workflows navigation by moving four event-driven workflows (Duplicate Issue Detector, Issue Triage, Issue Fixer, PR Actions Detective) from Human-coordinated to new Event-driven section. Consolidated Detector/Fixer Pairs and Standalone Scheduled subsections under new top-level Scheduled group.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 Workflows reorganized with care,
Event-driven here, scheduled there,
No more confusion in the fold,
New categories, clean and bold!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: split GitHub Agent workflows into human, event-driven, and scheduled' accurately describes the main changes reorganizing the documentation taxonomy into three categories.
Linked Issues check ✅ Passed All code changes directly address issue #325: the PR reorganizes docs into three categories (Human-Coordinated, Event-Driven, Scheduled) and updates both documentation content and MkDocs navigation accordingly.
Out of Scope Changes check ✅ Passed All changes are scoped to restructuring the workflow taxonomy in docs/workflows/gh-agent-workflows.md and mkdocs.yml; no unrelated modifications were introduced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/split-workflow-taxonomy-325-4bc12005a8a19366

Comment @coderabbitai help to get the list of available commands and usage tips.

@strawgate strawgate marked this pull request as ready for review February 21, 2026 18:02
Copy link
Contributor Author

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved: I found no actionable issues in this PR.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

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