Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zircote merged 2 commits into from
Feb 23, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7da911d
Initial plan
Copilot Feb 23, 2026
0154915
docs: apply review feedback to AGENTIC-WORKFLOWS.md and README.md
Copilot Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Guides for developers who just created a repository from this template.
| [Getting Started](template/GETTING-STARTED.md) | "Use this template" to first `cargo build` to first CI pass |
| [Configuration](template/CONFIGURATION.md) | Cargo.toml fields, placeholder replacement, feature flags, editor setup |
| [CI Workflows](template/CI-WORKFLOWS.md) | Every included workflow: triggers, secrets, how to enable/disable |
| [Agentic Workflows](workflows/AGENTIC-WORKFLOWS.md) | Autonomous AI agents: CI Doctor, Daily QA, Issue Triage, Q optimizer |
| [Agentic Workflows](workflows/AGENTIC-WORKFLOWS.md) | Autonomous AI agents: CI Doctor, Daily QA, Issue Triage, Q optimizer, Update Docs, Daily Documentation Review, Daily Repository Status |
| [Customization](template/CUSTOMIZATION.md) | Add modules, remove examples, adjust lints, modify release targets |
| [GitHub Template Features](template/GITHUB-TEMPLATE-FEATURES.md) | What copies when using a template -- and what doesn't |
| [Copilot Jumpstart](template/COPILOT-JUMPSTART.md) | Prompts for automatic project scaffolding with GitHub Copilot |
Expand All @@ -105,7 +105,7 @@ Detailed reference material organized by topic.

| Document | Description |
|----------|-------------|
| [Agentic Workflows](workflows/AGENTIC-WORKFLOWS.md) | Autonomous AI agents for CI/CD (CI Doctor, Daily QA, Issue Triage, Q optimizer, Update Docs) |
| [Agentic Workflows](workflows/AGENTIC-WORKFLOWS.md) | Autonomous AI agents for CI/CD (CI Doctor, Daily QA, Issue Triage, Q optimizer, Update Docs, Daily Documentation Review, Daily Repository Status) |
| [Coverage](workflows/COVERAGE.md) | Code coverage configuration and reporting |
| [Test Matrix](workflows/TEST-MATRIX.md) | Multi-platform and multi-version test matrix |
| [Benchmark Regression](workflows/BENCHMARK-REGRESSION.md) | Performance regression detection |
Expand Down
10 changes: 5 additions & 5 deletions docs/workflows/AGENTIC-WORKFLOWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Analyzes failed GitHub Actions workflows to identify root causes and patterns. P
- Daily Test Coverage Improver

**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.
- Adds labels: `automation`, `ci`
- Can comment on existing issues

Expand Down Expand Up @@ -99,11 +99,11 @@ Daily health check of repository status, open issues, PR backlog, and workflow p
- Workflow performance monitoring
- Stale issue detection
- Repository metrics tracking
- Status summaries via discussions
- Status summaries via GitHub issues

**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.
- Adds labels: `report`, `daily-status`

---

Expand Down Expand Up @@ -371,7 +371,7 @@ Use `/q` slash command in issues/PRs to invoke the Q workflow optimizer for inve
## Related Documentation

- [ADR-0001: Use Architectural Decision Records](../adr/0001-use-architectural-decision-records.md)
- [ADR-0003: Adopt Diataxis Documentation Framework](../adr/0003-adopt-diataxis-documentation-framework.md)
- [ADR-0003: Adopt Diátaxis Documentation Framework](../adr/0003-adopt-diataxis-documentation-framework.md)
- [CI Troubleshooting](../runbooks/CI-TROUBLESHOOTING.md)
- [Code Quality Metrics](CODE-QUALITY.md)

Expand Down
Loading