Software & DevOpsDone with Devin
Rewrite a README after a rearchitecture
Devin scanned a rearchitected codebase and delivered a new README as a PR with accurate setup and API details, but struggled with design rationale and purpose.
- What They Did
- After a major rearchitecture, the author gave Devin the repo and a step-by-step prompt. Devin scanned the code, read the old README, and proposed a headline outline. It then waited for a "CONFIRMED, PROCEED" command. Next it was told to forget the repo, follow its own setup instructions as a new developer, and report gaps. It then opened a PR from a branch off develop.
- How It Went
- The README had accurate setup steps, clear API endpoint specs, and examples inferred from the code. It struggled to explain design rationale and the project's overall purpose, which the codebase doesn't contain.
- Worth Knowing
- The author gives no timings, and suggests that supplying internal docs or architecture diagrams alongside the code might fix the missing rationale and purpose.
Try it yourself with Devin
My project at [path to repo] was recently rearchitected. Scan the code and rewrite the README with accurate setup steps, configuration, and API details, checking each command against the real code. Leave clearly marked placeholders for design rationale and project purpose that I will fill in. Put the change on a new branch and show me the diff before opening a PR.