Skip to content

Commit e615687

Browse files
committed
chore: update documentation and improve clarity across various files
1 parent 80873da commit e615687

21 files changed

Lines changed: 61 additions & 88 deletions

File tree

.agents/skills/humanizer/README.md

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -148,33 +148,10 @@ The skill also includes a final "obviously AI generated" audit pass and a second
148148
| 24 | **Excessive hedging** | "could potentially possibly" | "may" |
149149
| 25 | **Generic conclusions** | "The future looks bright" | Specific plans or facts |
150150

151-
## Full Example
152-
153-
**Before (AI-sounding):**
154-
> Great question! Here is an essay on this topic. I hope this helps!
155-
>
156-
> AI-assisted coding serves as an enduring testament to the transformative potential of large language models, marking a pivotal moment in the evolution of software development. In today's rapidly evolving technological landscape, these groundbreaking tools—nestled at the intersection of research and practice—are reshaping how engineers ideate, iterate, and deliver, underscoring their vital role in modern workflows.
157-
>
158-
> At its core, the value proposition is clear: streamlining processes, enhancing collaboration, and fostering alignment. It's not just about autocomplete; it's about unlocking creativity at scale, ensuring that organizations can remain agile while delivering seamless, intuitive, and powerful experiences to users. The tool serves as a catalyst. The assistant functions as a partner. The system stands as a foundation for innovation.
159-
>
160-
> Industry observers have noted that adoption has accelerated from hobbyist experiments to enterprise-wide rollouts, from solo developers to cross-functional teams. The technology has been featured in The New York Times, Wired, and The Verge. Additionally, the ability to generate documentation, tests, and refactors showcases how AI can contribute to better outcomes, highlighting the intricate interplay between automation and human judgment.
161-
>
162-
> - 💡 **Speed:** Code generation is significantly faster, reducing friction and empowering developers.
163-
> - 🚀 **Quality:** Output quality has been enhanced through improved training, contributing to higher standards.
164-
> -**Adoption:** Usage continues to grow, reflecting broader industry trends.
165-
>
166-
> While specific details are limited based on available information, it could potentially be argued that these tools might have some positive effect. Despite challenges typical of emerging technologies—including hallucinations, bias, and accountability—the ecosystem continues to thrive. In order to fully realize this potential, teams must align with best practices.
167-
>
168-
> In conclusion, the future looks bright. Exciting times lie ahead as we continue this journey toward excellence. Let me know if you’d like me to expand on any section!
169-
170-
**After (Humanized):**
171-
> AI coding assistants can speed up the boring parts of the job. They're great at boilerplate: config files and the little glue code you don't want to write. They can also help you sketch a test, but you still have to read it.
172-
>
173-
> The dangerous part is how confident the suggestions look. I've accepted code that compiled and passed lint, then discovered later it missed the point because I stopped paying attention.
174-
>
175-
> If you treat it like autocomplete and review every line, it's useful. If you use it to avoid thinking, it will help you ship bugs faster.
176-
>
177-
> The only real backstop is tests. Without them, you're mostly judging vibes.
151+
## Worked example
152+
153+
The README keeps the pattern summary for quick reference. `SKILL.md` contains the
154+
canonical guidance and worked examples the editor follows.
178155

179156
## References
180157

@@ -183,6 +160,7 @@ The skill also includes a final "obviously AI generated" audit pass and a second
183160

184161
## Version History
185162

163+
- **2.8.1** - Reduced README duplication; `SKILL.md` remains the canonical source for worked examples.
186164
- **2.8.0** - Added style/cadence patterns #31-33 for manufactured punchlines, aphorism formulas, and conversational rhetorical openers; expanded #20 to catch offer-to-continue chatbot closers. 33 patterns total.
187165
- **2.7.0** - Added pattern #30 (diff-anchored writing); made em/en dashes a hard cut rather than "overuse"; expanded #21 to cover speculative gap-filling ("maintains a low profile"). 30 patterns total.
188166
- **2.6.0** - Cleanup pass: consolidated the duplicated workflow sections, gated the personality guidance to content where voice is wanted, removed the model-fingerprinting subsection, and condensed the worked example. No change to the 29 patterns.

.agents/skills/humanizer/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: humanizer
3-
version: 2.8.0
3+
version: 2.8.1
44
description: |
55
Remove signs of AI-generated writing from text. Use when editing or reviewing
66
text to make it sound more natural and human-written. Based on Wikipedia's

.github/workflows/ci-doctor.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
description: |
3-
This workflow is an automated CI failure investigator that triggers when monitored workflows fail.
4-
Performs deep analysis of GitHub Actions workflow failures to identify root causes,
5-
patterns, and provide actionable remediation steps. Analyzes logs, error messages,
6-
and workflow configuration to help diagnose and resolve CI issues efficiently.
3+
This workflow investigates failures in Daily Perf Improver and Daily Test Coverage
4+
Improver. It analyzes their logs and configuration, then records actionable
5+
remediation when the evidence supports it.
76
87
on:
98
workflow_run:
@@ -38,7 +37,7 @@ timeout-minutes: 10
3837

3938
# CI Failure Doctor
4039

41-
You are the CI Failure Doctor, an expert investigative agent that analyzes failed GitHub Actions workflows to identify root causes and patterns. Your goal is to conduct a deep investigation when the CI workflow fails.
40+
You are the CI Failure Doctor. Investigate failures in the two monitored workflows, identify the supported cause, and record actionable remediation.
4241

4342
## Current Context
4443

@@ -55,7 +54,7 @@ You are the CI Failure Doctor, an expert investigative agent that analyzes faile
5554
### Phase 1: Initial Triage
5655

5756
1. **Verify Failure**: Check that `${{ github.event.workflow_run.conclusion }}` is `failure` or `cancelled`
58-
2. **Deduplication Check**: Read `/tmp/memory/investigations/analyzed-runs.json` from the cache. If the current run ID (`${{ github.event.workflow_run.id }}`) is already listed, **stop immediately** — this run has already been investigated. After completing a new investigation, append the run ID to this index to prevent re-analysis.
57+
2. **Deduplication Check**: If the cache restored `/tmp/memory/investigations/analyzed-runs.json`, read it. If the current run ID (`${{ github.event.workflow_run.id }}`) is already listed, **stop immediately** — this run has already been investigated. After completing a new investigation, append the run ID so it can be restored by a later run.
5958
3. **Get Workflow Details**: Use `get_workflow_run` to get full details of the failed run
6059
4. **List Jobs**: Use `list_workflow_jobs` to identify which specific jobs failed
6160
5. **Quick Assessment**: Determine if this is a new type of failure or a recurring pattern
@@ -79,8 +78,7 @@ You are the CI Failure Doctor, an expert investigative agent that analyzes faile
7978

8079
### Phase 3: Historical Context Analysis
8180

82-
1. **Search Investigation History**: Use file-based storage to search for similar failures:
83-
- Read from cached investigation files in `/tmp/memory/investigations/`
81+
1. **Search Investigation History**: If the cache restored prior investigation files, search `/tmp/memory/investigations/` for similar failures:
8482
- Parse previous failure patterns and solutions
8583
- Look for recurring error signatures
8684
2. **Issue History**: Search existing issues for related problems
@@ -105,7 +103,7 @@ You are the CI Failure Doctor, an expert investigative agent that analyzes faile
105103

106104
### Phase 5: Pattern Storage and Knowledge Building
107105

108-
1. **Store Investigation**: Save structured investigation data to files:
106+
1. **Store Investigation**: Save structured investigation data for cache capture:
109107
- Write investigation report to `/tmp/memory/investigations/<timestamp>-<run-id>.json`
110108
- Store error patterns in `/tmp/memory/patterns/`
111109
- Maintain an index file of all investigations for fast searching
@@ -192,8 +190,8 @@ When creating an investigation issue, use this structure:
192190

193191
## Cache Usage Strategy
194192

195-
- Store investigation database and knowledge patterns in `/tmp/memory/investigations/` and `/tmp/memory/patterns/`
193+
- Use `/tmp/memory/investigations/` and `/tmp/memory/patterns/` as cache-backed working storage; do not assume they exist unless the cache restores them.
196194
- Cache detailed log analysis and artifacts in `/tmp/investigation/logs/` and `/tmp/investigation/reports/`
197-
- Persist findings across workflow runs using GitHub Actions cache
195+
- Make findings available to later runs through the configured GitHub Actions cache
198196
- Build cumulative knowledge about failure patterns and solutions using structured JSON files
199197
- Use file-based indexing for fast pattern matching and similarity detection

.github/workflows/issue-triage-agent.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ imports:
3030

3131
# Issue Triage Agent
3232

33-
List open issues in ${{ github.repository }} that have no labels. For each unlabeled issue, analyze the title and body, then add one of the allowed labels: `bug`, `feature`, `enhancement`, `documentation`, `question`, `help-wanted`, or `good-first-issue`, `community`.
33+
List open issues in ${{ github.repository }} that have no labels. For each unlabeled issue, analyze the title and body, then add one allowed label: `bug`, `feature`, `enhancement`, `documentation`, `question`, `help-wanted`, or `good-first-issue`.
3434

3535
Skip issues that:
3636
- Already have any of these labels
@@ -87,5 +87,4 @@ This provides both per-issue context and batch visibility.
8787
- `documentation`: Pertains to issues related to documentation, such as missing or unclear docs.
8888
- `question`: Used for issues that are asking for clarification or have questions about the project.
8989
- `help-wanted`: Indicates that the issue is a good candidate for external contributions and help
90-
- `good-first-issue`: Marks issues that are suitable for newcomers to the project, often with simpler scope.
91-
- `community`: Indicates that the issue is related to community engagement, such as events, discussions, or contributions that don't fit into the other categories. From authors who are not contributors to the codebase but are engaging with the project in other ways.
90+
- `good-first-issue`: Marks issues that are suitable for newcomers to the project, often with simpler scope.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Agentic DevSecOps
22

3-
One repo. One GitHub Pages site. Five adoption journeys, four delivery session modules, 59 activities, zero configuration drama.
3+
One GitHub Pages curriculum with five adoption journeys, four delivery-session modules, and 59 activities.
44

55
> **Bring your own.** These activities are built to run on **your** tenant — work each one
66
> against your own applications, repositories, and data so the result keeps running in

modules/ghas/resources/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ This directory contains GitHub Advanced Security (GHAS) configuration files that
44
to the org-owned Juice Shop repository provisioned in Activity S00 to enable GHAS scanning
55
features during the delivery session.
66

7-
These fixtures are maintained in this repository and are
8-
now vendored here so that repository can be retired.
7+
These fixtures were moved here from a retired predecessor repository. Keeping
8+
them with the curriculum makes the setup reproducible without another source
9+
repository.
910

1011
## Files
1112

modules/ghas/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These are separate. You run Juice Shop locally for testing; the org repository i
99

1010
## GHAS Target Repository
1111

12-
For Activity S00, a participant, team lead, or organizer should create the GHAS target in an org they control. Use the provided setup scripts:
12+
For Activity S00, a participant, team lead, or organizer should create the GHAS target in an org they control. GHAS reuses the shared GHEC provisioning scripts because they provide the common org setup and safety checks. Use the provided setup scripts:
1313

1414
```bash
1515
cd modules/ghec/resources/provisioning/scripts

modules/ghaw/challenges/01-morning-briefing/COACH.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ This is a concise review overlay. Apply the [Delivery Assurance Standard](../../
1212
## Session-specific reviewer focus
1313

1414
- Pitfall 1: Incorrect cron syntax
15-
- Pitfall 2: No workflowdispatch: for testing
15+
- Pitfall 2: No `workflow_dispatch` trigger for testing
1616
- Pitfall 3: Trying to call GitHub API directly instead of using the tool

modules/ghaw/challenges/03-the-watcher/COACH.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ This is a concise review overlay. Apply the [Delivery Assurance Standard](../../
1212
## Session-specific reviewer focus
1313

1414
- Pitfall 1: Path filter is too specific or wrong
15-
- Pitfall 2: Forgot to include workflowdispatch
15+
- Pitfall 2: Forgot to include `workflow_dispatch`
1616
- Pitfall 3: Trying to read commit diff directly instead of using GitHub MCP

modules/ghaw/challenges/07-slash-and-burn/meta.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ success_criteria:
2121
- The workflow runs (visible in Actions tab)
2222
- A summary comment appears within 30 seconds
2323
- Summary includes:
24-
- Issue title and current state
25-
- At least 2 key points from the discussion
26-
- Next steps or recommendation
24+
- Issue title and current state
25+
- At least 2 key points from the discussion
26+
- Next steps or recommendation
2727
- Only authorized users (repo members) can trigger the command
2828
tags:
2929
- slash-commands

0 commit comments

Comments
 (0)