Skip to content

docs: add comprehensive agentic workflows documentation#98

Merged
zircote merged 4 commits intomainfrom
docs/add-agentic-workflows-documentation-0a5d09e5401bb94b
Feb 23, 2026
Merged

docs: add comprehensive agentic workflows documentation#98
zircote merged 4 commits intomainfrom
docs/add-agentic-workflows-documentation-0a5d09e5401bb94b

Conversation

@zircote
Copy link
Owner

@zircote zircote commented Feb 23, 2026

Summary

Adds comprehensive documentation for all agentic workflows in the repository, addressing a documentation gap identified during automated documentation review.

Changes

  • New file: docs/workflows/AGENTIC-WORKFLOWS.md - Complete reference for all 7 agentic workflows
  • Updated: docs/README.md - Added links to new documentation in both Workflows and Template sections

Documentation Coverage

The new documentation covers:

Workflows Documented

  1. CI Doctor - Automated CI failure investigation

    • Triggers on workflow failures
    • Root cause analysis
    • Automated issue creation
  2. Daily Documentation Review - Validate docs against external sources

    • Daily schedule
    • Cross-references authoritative sources
    • Automated correction PRs
  3. Daily QA - Autonomous quality assurance

    • Build and test validation
    • Documentation clarity checks
    • Code structure analysis
  4. Daily Repository Status - Repository health monitoring

    • Issue/PR backlog analysis
    • Workflow performance tracking
    • Status summaries
  5. Issue Triage - Intelligent issue classification

    • Automatic labeling
    • Spam detection
    • Similar issue detection
  6. Q - Workflow Optimizer - Performance investigation

    • /q slash command triggered
    • Performance analysis
    • Optimization PRs
  7. Update Docs - Documentation synchronization

    • Triggered on main branch pushes
    • Code-to-docs alignment
    • Diátaxis framework compliance

Reference Content

  • Workflow descriptions and triggers
  • Features and capabilities
  • Safe outputs configuration
  • Network access patterns
  • Tools configuration
  • Compilation process (gh aw compile)
  • Best practices and guidelines
  • Related documentation links

Testing

  • Documentation follows Diátaxis framework (Reference content)
  • Links verified in docs/README.md
  • Markdown formatting validated
  • Cross-references to related documentation included
  • Active voice, plain English, developer-friendly tone

Checklist

  • Documentation is accurate and complete
  • Documentation index updated
  • Links are valid
  • Follows project style guidelines
  • No sensitive information included

Related

Closes documentation gap for agentic workflows (ci-doctor, daily-docs-review, daily-qa, daily-repo-status, issue-triage, q, update-docs) that were not previously documented in docs/workflows/.

AI generated by Update Docs

Add detailed documentation for all agentic workflows in the repository:
- CI Doctor: automated CI failure investigation
- Daily Documentation Review: validate docs against external sources
- Daily QA: autonomous quality assurance checks
- Daily Repository Status: repository health monitoring
- Issue Triage: intelligent issue classification and labeling
- Q: agentic workflow optimizer for performance improvement
- Update Docs: documentation synchronization with code changes

Documentation includes workflow descriptions, triggers, features,
safe outputs configuration, network access, tools configuration,
compilation process, and best practices.

Updated docs/README.md index to reference the new agentic workflows
documentation in both the Workflows section and Template Adoption
section for improved discoverability.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@zircote zircote added automation documentation Improvements or additions to documentation labels Feb 23, 2026
@github-actions
Copy link
Contributor

Benchmark Results

No benchmarks configured. Add benchmarks to benches/ directory.

Full results available in CI artifacts.

@codecov
Copy link

codecov bot commented Feb 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.83%. Comparing base (3656a48) to head (1e11581).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files           9        9           
  Lines        6499     6499           
=======================================
  Hits         6228     6228           
  Misses        271      271           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Contributor

Code Coverage Report

Overall Coverage: 0%

Summary

Filename                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
client.rs                        1444                67    95.36%         118                13    88.98%         923                35    96.21%           0                 0         -
format.rs                        2172                 3    99.86%         132                 1    99.24%        1292                 1    99.92%           0                 0         -
main.rs                           326               241    26.07%          14                 8    42.86%         225               168    25.33%           0                 0         -
mcp/analytics.rs                  408                 2    99.51%          24                 0   100.00%         331                 0   100.00%           0                 0         -
mcp/mod.rs                        144                55    61.81%          23                15    34.78%         128                65    49.22%           0                 0         -
mcp/prompts.rs                   1908                33    98.27%         126                 6    95.24%        1043                12    98.85%           0                 0         -
mcp/resources.rs                 1317                20    98.48%          93                 1    98.92%         865                 6    99.31%           0                 0         -
mcp/tools.rs                     2146                90    95.81%         116                18    84.48%        1333                47    96.47%           0                 0         -
models.rs                        1079                31    97.13%          78                10    87.18%         762                14    98.16%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                           10944               542    95.05%         724                72    90.06%        6902               348    94.96%           0                 0         -

Full HTML report available in CI artifacts.

@zircote zircote marked this pull request as ready for review February 23, 2026 05:33
Copilot AI review requested due to automatic review settings February 23, 2026 05:33
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the repository's 7 agentic workflows, filling a significant documentation gap. The new AGENTIC-WORKFLOWS.md file provides reference documentation covering all autonomous AI agents that monitor and maintain the repository through GitHub Actions, including workflow descriptions, triggers, features, configuration patterns, and best practices.

Changes:

  • Created comprehensive reference documentation for all 7 agentic workflows (CI Doctor, Daily Documentation Review, Daily QA, Daily Repository Status, Issue Triage, Q optimizer, and Update Docs)
  • Added navigation links in docs/README.md under both "Template Adoption Guides" and "Additional Reference > Workflows" sections
  • Documented workflow compilation process, network configuration, safe outputs, and tools configuration patterns

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/workflows/AGENTIC-WORKFLOWS.md New comprehensive reference documentation covering all 7 agentic workflows with consistent structure: triggers, features, safe outputs, network access, and configuration examples
docs/README.md Added two navigation entries linking to the new agentic workflows documentation in the Template Adoption Guides and Workflows Reference sections

@zircote
Copy link
Owner Author

zircote commented Feb 23, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Contributor

Copilot AI commented Feb 23, 2026

@zircote I've opened a new pull request, #99, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits February 23, 2026 05:55
Co-authored-by: zircote <307960+zircote@users.noreply.github.com>
docs: fix review feedback in AGENTIC-WORKFLOWS.md and README.md
@github-actions
Copy link
Contributor

Benchmark Results

No benchmarks configured. Add benchmarks to benches/ directory.

Full results available in CI artifacts.

@zircote zircote merged commit a2ff8f3 into main Feb 23, 2026
27 checks passed
@zircote zircote deleted the docs/add-agentic-workflows-documentation-0a5d09e5401bb94b branch February 23, 2026 13:06
@github-actions
Copy link
Contributor

Code Coverage Report

Overall Coverage: 0%

Summary

Filename                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
client.rs                        1444                67    95.36%         118                13    88.98%         923                35    96.21%           0                 0         -
format.rs                        2172                 3    99.86%         132                 1    99.24%        1292                 1    99.92%           0                 0         -
main.rs                           326               241    26.07%          14                 8    42.86%         225               168    25.33%           0                 0         -
mcp/analytics.rs                  408                 2    99.51%          24                 0   100.00%         331                 0   100.00%           0                 0         -
mcp/mod.rs                        144                55    61.81%          23                15    34.78%         128                65    49.22%           0                 0         -
mcp/prompts.rs                   1908                33    98.27%         126                 6    95.24%        1043                12    98.85%           0                 0         -
mcp/resources.rs                 1317                20    98.48%          93                 1    98.92%         865                 6    99.31%           0                 0         -
mcp/tools.rs                     2146                90    95.81%         116                18    84.48%        1333                47    96.47%           0                 0         -
models.rs                        1079                31    97.13%          78                10    87.18%         762                14    98.16%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                           10944               542    95.05%         724                72    90.06%        6902               348    94.96%           0                 0         -

Full HTML report available in CI artifacts.

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.

3 participants