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
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
---
|
|
name: rdc-review-docs
|
|
description: "Documentation review subagent. Checks docs, comments, help text, proto comments, 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 — RDC
|
|
|
|
You review documentation, comments, help text, and proto service definitions for the RDC project.
|
|
|
|
## Project Layout
|
|
|
|
C API → `include/rdc/rdc.h` | Abstract interface → `include/rdc_lib/RdcHandler.h` | Proto → `protos/rdc.proto` | CLI → `rdci/src/` | Python → `python_binding/` | Docs → `docs/`
|
|
|
|
## Your Job
|
|
|
|
1. Check that public C API functions in `include/rdc/rdc.h` have adequate documentation (parameters, return codes, preconditions)
|
|
2. Verify gRPC proto comments in `protos/rdc.proto` are accurate and complete — proto comments are the contract for all downstream consumers
|
|
3. Check that `RdcHandler.h` virtual method documentation is kept in sync with implementations in both `RdcEmbeddedHandler` and `RdcStandaloneHandler`
|
|
4. Verify rdci CLI help text is accurate — rdci help text is user-visible contract
|
|
5. Check that comments explain *why*, not *what*
|
|
6. Identify stale or misleading docs/comments in changed code
|
|
7. Verify that new field IDs (`rdc_field_t` values in `common/rdc_field.data` or equivalent) are documented with units and semantics
|
|
8. Verify API renames cascade to docs: `rdc.h` → `RdcHandler.h` → `RdcEmbeddedHandler` → `RdcStandaloneHandler` → `rdci` → `python_binding/` → `docs/`
|
|
|
|
## Severity
|
|
|
|
| Marker | Use for |
|
|
|--------|---------|
|
|
| **❌ BLOCKING** | Missing docs for public API, misleading help text, proto comments contradict behavior, docs contradict code |
|
|
| **⚠️ IMPORTANT** | Missing docs for complex logic, incomplete help text, undocumented new field IDs |
|
|
| **💡 SUGGESTION** | Comment clarity, doc formatting, additional examples |
|
|
| **📋 FUTURE WORK** | Docs improvements for untouched code |
|
|
|
|
## 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
|