Skip to content

Commit 9f45418

Browse files
committed
docs: cleanup README and FIELD_REFERENCE to remove unimplemented features
1 parent ac49148 commit 9f45418

2 files changed

Lines changed: 167 additions & 128 deletions

File tree

workflows/cve-fixer/FIELD_REFERENCE.md

Lines changed: 10 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This document provides detailed information about the configuration fields in `.
1313
### description
1414
- **Type:** string
1515
- **Purpose:** Explains workflow purpose in UI
16-
- **Current Value:** "This workflow can be used to scan your code base for CVEs and fix discovered CVEs"
16+
- **Current Value:** "Automate remediation of CVE issues reported by ProdSec team in Jira by creating pull requests with dependency updates and patches"
1717
- **Guidelines:** 1-3 sentences, clear and specific about workflow capabilities
1818

1919
### systemPrompt
@@ -81,17 +81,13 @@ This document provides detailed information about the configuration fields in `.
8181

8282
### Adding a new output type
8383

84-
If you want to track additional artifacts (e.g., "Remediation Scripts"):
84+
If you want to track additional artifacts (e.g., "Test Results"):
8585

8686
```json
8787
"results": {
88-
"Scan Results": "artifacts/cve-fixer/scans/**/*.json",
89-
"Analysis Reports": "artifacts/cve-fixer/analysis/**/*.md",
90-
"Priority Matrices": "artifacts/cve-fixer/priorities/**/*.md",
88+
"Jira CVE Issues": "artifacts/cve-fixer/find/**/*.md",
9189
"Fix Implementations": "artifacts/cve-fixer/fixes/**/*",
92-
"Verification Results": "artifacts/cve-fixer/verification/**/*.md",
93-
"Remediation Reports": "artifacts/cve-fixer/reports/**/*.md",
94-
"Remediation Scripts": "artifacts/cve-fixer/scripts/**/*.sh"
90+
"Test Results": "artifacts/cve-fixer/tests/**/*.log"
9591
}
9692
```
9793

@@ -102,15 +98,15 @@ To use a different base directory (e.g., `security-artifacts/`):
10298
1. Update `systemPrompt` OUTPUT LOCATIONS section:
10399
```
104100
OUTPUT LOCATIONS:
105-
- Create all scan results in: security-artifacts/cve-fixer/scans/
106-
...
101+
- Create all Jira CVE findings in: security-artifacts/cve-fixer/find/
102+
- Create all fix implementations in: security-artifacts/cve-fixer/fixes/
107103
```
108104

109105
2. Update `results` paths:
110106
```json
111107
"results": {
112-
"Scan Results": "security-artifacts/cve-fixer/scans/**/*.json",
113-
...
108+
"Jira CVE Issues": "security-artifacts/cve-fixer/find/**/*.md",
109+
"Fix Implementations": "security-artifacts/cve-fixer/fixes/**/*"
114110
}
115111
```
116112

@@ -139,25 +135,6 @@ KEY RESPONSIBILITIES:
139135
...
140136
```
141137

142-
## Agent Files
143-
144-
Agent persona files are located in `.claude/agents/` and follow this structure:
145-
146-
```markdown
147-
# {Name} - {Role}
148-
## Role
149-
## Expertise
150-
## Responsibilities
151-
## Communication Style
152-
## When to Invoke
153-
## Tools and Techniques
154-
## Key Principles
155-
## Example Artifacts
156-
```
157-
158-
**Current Agent:**
159-
- `vera-security-engineer.md` - Security engineering specialist for CVE remediation
160-
161138
## Command Files
162139

163140
Slash command files are located in `.claude/commands/` and follow this structure:
@@ -181,8 +158,7 @@ Slash command files are located in `.claude/commands/` and follow this structure
181158
## File Naming Conventions
182159

183160
- **Workflow directory:** `workflows/cve-fixer/`
184-
- **Agent files:** `{name}-{role}.md` (e.g., `vera-security-engineer.md`)
185-
- **Command files:** `{workflow-prefix}.{phase}.md` (e.g., `cve.scan.md`)
161+
- **Command files:** `{workflow-prefix}.{phase}.md` (e.g., `cve.find.md`, `cve.fix.md`)
186162
- **Artifacts:** `artifacts/cve-fixer/{category}/{files}`
187163

188164
## Validation Checklist
@@ -191,11 +167,10 @@ Before using this workflow, verify:
191167

192168
- [ ] `.ambient/ambient.json` is valid JSON (no comments, no trailing commas)
193169
- [ ] All required fields (name, description, systemPrompt, startupPrompt) are present
194-
- [ ] All agent files follow the template structure with required sections
195170
- [ ] All command files have unique names and follow naming convention
196171
- [ ] Output paths in `results` match those referenced in `systemPrompt`
197172
- [ ] Output paths in `results` match those in command files' ## Output sections
198-
- [ ] README.md accurately describes the workflow and all phases
173+
- [ ] README.md accurately describes the workflow and implemented commands
199174
- [ ] All file references use correct absolute or relative paths
200175

201176
## Configuration Best Practices
@@ -221,9 +196,6 @@ Before using this workflow, verify:
221196
**Problem:** Commands don't appear
222197
**Solution:** Ensure command files are in `.claude/commands/` and follow naming convention `{prefix}.{phase}.md`.
223198

224-
**Problem:** Agent isn't being invoked
225-
**Solution:** Check that agent file exists in `.claude/agents/` and is referenced in workflow context.
226-
227199
## References
228200

229201
- [ACP Documentation](https://ambient-code.github.io/vteam)

0 commit comments

Comments
 (0)