Documentation Updater
Find outdated docs, compare with code, and update documentation files
Example Prompt
Check our documentation for anything that's out of date compared to the actual code and update it
About
Identifies documentation that has drifted from the actual codebase by comparing doc references with current source files. Flags outdated sections, generates corrected content, and writes the updates directly to the documentation files to keep everything in sync.
Workflow Steps
List the docs directory to find all documentation files
📁 List DirectoryRead existing documentation files to identify references to code patterns and APIs
📄 Read FileRead the referenced source files from the repository to get the current state
📃 Read Repo FileCompare documentation against source code and identify outdated sections
🧠 Structured ReasoningWrite the corrected and updated documentation back to the files
✏️ Write FileTools Used
List Directory
List all files and subdirectories in a given directory path
Read File
Read the contents of a file at a specified path on the local filesystem
Write File
Write or overwrite a file at a specified path with the given content
Read Repo File
Read the contents of a file from a GitHub repository at a specific branch or commit
Structured Reasoning
Break down a complex problem into sequential reasoning steps with explicit chain-of-thought