Menu
Check doc-code content consistency. For RST/Markdown formatting, use lint-code.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Review SUEWS PRs. Drafts comments for approval before posting.
Use whenever the user wants to fix a SUEWS GitHub issue into a validated, PR-ready branch. Trigger for requests like "fix issue
Use whenever auditing, clarifying, rewriting, labelling, or batch-reviewing SUEWS GitHub issues so they become maintainer-ready. Trigger for requests like "audit this issue", "make this issue agent-ready", "rewrite issue
Use whenever auditing, prioritising, or batch-triaging SUEWS draft and stalled pull requests so each gets a clear disposition. Trigger for "triage PRs", "which draft PRs need attention", "what's the disposition of these PRs", "groom the PR backlog", "defer this PR with a reason", "which PRs are ready to advance to merge", or a scheduled PR-backlog sweep. Routes live PRs to prep-pr/split-pr/queue-pr; defers or escalates the rest; never merges or closes.
Prepare SUEWS release with pre-flight checks and tag generation.
Documentation sanity check for SUEWS source files. Two checks under one roof - non-ASCII characters in sphinx-gallery tutorials/RST/docstrings (with context-aware RST/LaTeX/matplotlib replacement), and bibliography topic-tag convention plus metadata backfill on the refs bib files. Use when editing docs/source files or the refs-*.bib files, when a doc hook flags an issue, or when asked to "audit docs", "check docs", "fix non-ASCII", "check bib tags", "curate refs". Complements sync-docs (doc-code content consistency) and lint-code (code style).
| name | sync-docs |
| description | Check doc-code content consistency. For RST/Markdown formatting, use lint-code. |
Check documentation content matches codebase (values, signatures, parameters).
| Area | Code Location | Doc Location | Priority |
|---|---|---|---|
| Scientific | src/suews/src/suews_phys_*.f95 | docs/source/parameterisations-and-sub-models.rst | Critical |
| API | src/supy/*.py | docs/source/api/ | Critical |
| Config | src/supy/data_model/ | docs/source/inputs/yaml/ | High |
| Output vars | src/supy/data_model/output/ | docs/source/output_files/ | High |
| Build | Makefile | README.md, installation docs | Medium |
Details: references/areas-to-check.md
[sync-docs] Documentation-Code Consistency Report
=== [Area] ===
file.rst:
L45: Issue description
Summary: N issues (X critical, Y high, Z medium)
references/areas-to-check.md - Detailed check areas with examplesreferences/data-model-checks.md - Pydantic fields and output variablesreferences/verification-commands.md - Bash/Python verification scripts