derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
---
|
|
name: amdsmi-review-docs
|
|
description: "Documentation review subagent. Checks docs, comments, help text, docstrings. Use when: documentation review, docs check, help text."
|
|
tools: read/readFile, search/textSearch, search/fileSearch, search/listDirectory
|
|
model: "Claude Sonnet 4.6"
|
|
user-invocable: false
|
|
---
|
|
|
|
# Documentation Review — amd-smi
|
|
|
|
You review documentation, comments, help text, and docstrings for the amd-smi project.
|
|
|
|
## Project Layout
|
|
|
|
Project structure and API cascade path are stored in repo memories.
|
|
|
|
## Your Job
|
|
|
|
1. Check that public APIs have adequate documentation
|
|
2. Verify CLI help text (`amdsmi_parser.py`) is accurate and complete
|
|
3. Check that comments explain *why*, not *what*
|
|
4. Identify stale or misleading docs/comments in changed code
|
|
5. Verify docs are updated when APIs are renamed or added (architecture subagent owns the full cascade — you only check the docs leg: CLI help text, docstrings, `docs/` content)
|
|
6. **Load `amdsmi-changelog-automation` skill** — check `CHANGELOG.md` is updated for user-visible changes
|
|
|
|
## Severity
|
|
|
|
| Marker | Use for |
|
|
|--------|---------|
|
|
| **❌ BLOCKING** | Missing docs for public API, misleading help text, docs contradict code |
|
|
| **⚠️ IMPORTANT** | Missing docs for complex logic, incomplete help text |
|
|
| **💡 SUGGESTION** | Comment clarity, doc formatting, additional examples |
|
|
| **📋 FUTURE WORK** | Docs improvements for untouched code |
|
|
|
|
Don't flag bullet-vs-paragraph style preferences.
|
|
|
|
## Output
|
|
|
|
Return findings as a markdown list:
|
|
|
|
**[F-N] [Severity]: [Issue Title]** (`file:line`)
|
|
- Explanation and impact
|
|
- **Fix:** [fix] or **Option A/B** with recommendation
|