README Improvement Loop

Goal

Improve onboarding documentation

How to Run

Run this loop in your coding agent to iteratively improve your project's README. It will test the setup process, identify gaps in documentation, and suggest improvements until a successful setup is achieved from the README alone.

1. 01

   Provide Project Context

   Share your project's README and any relevant setup documentation with the agent.

2. 02

   Initiate Loop

   Ask the agent to start the README Improvement Loop with the goal of improving onboarding documentation.

3. 03

   Review Feedback

   After each iteration, review the setup test results and documentation suggestions provided by the agent.

4. 04

   Apply Changes

   Update your README based on the agent's recommendations and restart the loop if needed.

Workflow Steps

1. 01

   Analyze current README for completeness and accuracy of setup instructions

2. 02

   Run the 'fresh setup test' to verify if instructions work as documented

3. 03

   If test fails: Identify specific documentation gaps causing the failure

4. 04

   Update README with clearer instructions, missing steps, or corrections

5. 05

   If test passes: Check for clarity, beginner-friendliness, and completeness

6. 06

   Iterate until setup works from README or max iterations reached

Start the "README Improvement Loop" loop.

Goal: Improve onboarding documentation
Max iterations: 10
Between iterations run: fresh setup test
Exit when: Setup works from README


I want to improve my project's onboarding documentation. My goal is to ensure someone can successfully set up and run this project by following only the README instructions. Please run the README Improvement Loop to help me achieve this. Start by analyzing my current README for potential issues, then run a fresh setup test to see if it works as documented. Continue iterating until we meet the exit condition where the setup works from the README, or until we reach 10 iterations.

Self-pace this loop. After each iteration, run `fresh setup test` and evaluate the output, and only continue if the exit condition is not met (Setup works from README). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.