Skip to content

docs: fix review feedback in AGENTIC-WORKFLOWS.md and README.md#99

Merged
zircote merged 2 commits intodocs/add-agentic-workflows-documentation-0a5d09e5401bb94bfrom
copilot/sub-pr-98
Feb 23, 2026
Merged

docs: fix review feedback in AGENTIC-WORKFLOWS.md and README.md#99
zircote merged 2 commits intodocs/add-agentic-workflows-documentation-0a5d09e5401bb94bfrom
copilot/sub-pr-98

Conversation

Copy link
Contributor

Copilot AI commented Feb 23, 2026

Four inaccuracies and omissions in the agentic workflows documentation identified during PR review.

Changes

  • CI Doctor safe-outputs: Removed literal [CI Doctor] brackets — the workflow uses title-prefix: "${{ github.workflow }}" which expands without brackets
  • Daily Repository Status: Corrected create-discussioncreate-issue with accurate [repo-status] prefix and report/daily-status labels; removed non-existent add-comment safe-output; fixed "discussions" → "GitHub issues" in the Features list
  • Diátaxis spelling: Fixed DiataxisDiátaxis in the ADR-0003 link (line 374)
  • README.md completeness: Added "Daily Documentation Review" and "Daily Repository Status" to both workflow table entries so all 7 documented workflows are represented

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: zircote <307960+zircote@users.noreply.github.com>
Copilot AI changed the title [WIP] Add comprehensive documentation for agentic workflows docs: fix review feedback in AGENTIC-WORKFLOWS.md and README.md Feb 23, 2026
@zircote zircote marked this pull request as ready for review February 23, 2026 13:04
@zircote zircote self-requested a review as a code owner February 23, 2026 13:04
Copilot AI review requested due to automatic review settings February 23, 2026 13:04
@zircote zircote merged commit 1e11581 into docs/add-agentic-workflows-documentation-0a5d09e5401bb94b Feb 23, 2026
29 checks passed
@zircote zircote deleted the copilot/sub-pr-98 branch February 23, 2026 13:05
@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.

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 corrects inaccuracies in the agentic workflows documentation so the documented safe-outputs and workflow inventory match the actual GitHub Actions workflow definitions.

Changes:

  • Updates the documented safe-outputs/behavior for CI Doctor and Daily Repository Status to align with the workflows’ configured outputs.
  • Fixes the Diátaxis spelling in the ADR-0003 link text.
  • Expands docs/README.md entries so all documented agentic workflows are listed.

Reviewed changes

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

File Description
docs/workflows/AGENTIC-WORKFLOWS.md Adjusts safe-output descriptions for CI Doctor and Daily Repository Status; updates ADR-0003 link text.
docs/README.md Updates workflow listings to include Daily Documentation Review and Daily Repository Status.


**Safe Outputs:**
- Creates issues with `[CI Doctor]` prefix
- Creates issues prefixed with the workflow name (for example, `CI Doctor`)
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

title-prefix: "${{ github.workflow }}" in .github/workflows/ci-doctor.md resolves to the workflow's configured name (in the compiled workflow this is CI Failure Doctor), not CI Doctor. The example here should match the actual workflow name or avoid a concrete example (e.g., describe it as "prefixed with ${{ github.workflow }}").

Suggested change
- Creates issues prefixed with the workflow name (for example, `CI Doctor`)
- Creates issues prefixed with the workflow name (via `${{ github.workflow }}`)

Copilot uses AI. Check for mistakes.
**Safe Outputs:**
- Creates discussions for status reports
- Can comment on stale issues
- Creates issues for status reports with `[repo-status]` title prefix
Copy link

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

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

The Daily Repository Status workflow's safe-output title-prefix is defined as "[repo-status] " (note the trailing space). For copy/paste accuracy, consider reflecting the exact prefix here (including the space) or explicitly stating that a space follows the tag.

Suggested change
- Creates issues for status reports with `[repo-status]` title prefix
- Creates issues for status reports with `[repo-status] ` title prefix (note trailing space)

Copilot uses AI. Check for mistakes.
@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 (3e8c2d8) to head (0154915).

Additional details and impacted files
@@                                    Coverage Diff                                     @@
##           docs/add-agentic-workflows-documentation-0a5d09e5401bb94b      #99   +/-   ##
==========================================================================================
  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.

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.

3 participants