Rewrite a README after a codebase rearchitecture

A developer had Devin scan a reworked repository and draft a new README with setup and API details in a pull request.

Done with Devin· Intermediate

What they did
After a major rearchitecture, the developer handed Devin the repository and a step-by-step set of instructions. Devin reviewed the code and the old README, then suggested a high-level outline before pausing for approval. After being told to treat the project like a fresh developer, it checked its own setup steps, flagged gaps, and opened a pull request from a branch based on develop.
How it went
The new README included correct setup instructions, API endpoint descriptions, and examples drawn from the code. It had trouble with the project’s purpose and design reasoning, since those details were not present in the codebase.
Tips
If you want better coverage of architecture decisions, give the agent internal docs or diagrams along with the code. Ask it to mark anything uncertain so you can review it before merge.

Try it yourself with Devin

I need to update the README for [repo path] after a major rearchitecture. First, scan the codebase and the current README, then draft an outline for a revised README with setup, configuration, and API sections. Pause and wait for my confirmation before making any changes. After I reply "CONFIRMED, PROCEED", recheck the repository as if you were a new developer, verify each setup command against the code, and note any missing details or unclear parts. Write the updated README in [file path], keep placeholders where design rationale or project purpose cannot be verified from the code, and show me the diff on a new branch before opening a pull request.

Fill in the [brackets]. Agents can make mistakes, so review anything before it is sent, paid or deleted.

Read the original on medium.com ↗

Get 3 agent uses like this every morning

With the day's top AI news. Free, and one click to unsubscribe.