ReddRadar
Agent skill
Sync Documentation
Use this skill at the end of a task to ensure documentation matches the code.
Install this agent skill to your Project
npx add-skill https://github.com/CheekyCodexConjurer/quant-lab/tree/main/skills/sync_docs
SKILL.md
Sync Documentation
Use this skill to prevent documentation drift after you change behavior, flows, or structure.
Checklist
architecture.md(index)
- New module/service/folder? -> add it to the index
- Changed a main flow? -> update the relevant
docs/architecture/*page(s)
docs/architecture/(leaf docs)
- Update the page(s) that map to the modified area (backend core/data/indicators, chart map, flows, runs/logging, etc.)
- Keep each doc short and linkable (LLM-friendly)
README.md
- New env var? -> document it
- Changed how to run/test? -> update commands
ROADMAP.md
- Completed an item? -> mark it done
- New work discovered? -> add it
Output requirement
In the final response, explicitly list:
Updated: architecture.md(if changed)Updated: docs/architecture/...(if changed)Updated: README.md/Updated: ROADMAP.md(if changed)
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
CheekyCodexConjurer/quant-lab
action_logger
Keep an audit trail of changes, commands, and verification.
CheekyCodexConjurer/quant-lab
size_guard
Enforce line budgets and rotate or split large context files.
CheekyCodexConjurer/quant-lab
analyze_repo_capabilities
Detect repo tooling and patterns, then record a dynamic manifest.
CheekyCodexConjurer/quant-lab
safety_validation
Validate changes against .agentignore before commit.
CheekyCodexConjurer/quant-lab
safe_refactor_migration
Plan and execute large refactors with shadow mode and rollback.
CheekyCodexConjurer/quant-lab
command_guard
Enforce .agentpolicy rules before executing commands.
Didn't find tool you were looking for?