Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s README to simplify the “Quick Start” and replace the existing detailed usage/contribution guidance with a shorter set of instructions.
Changes:
- Simplifies the “Initialize” steps in Quick Start.
- Replaces the existing Contributing section with a generic 5-step contribution checklist.
- Updates the License section to reference the
LICENSEfile.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| cd your-project | ||
| wit init | ||
| wit start |
There was a problem hiding this comment.
wit start is documented in the Quick Start, but the CLI doesn't appear to provide a start subcommand (commands are init, status, declare, lock, release, watch, etc.). Also, wit init already starts the daemon via ensureDaemon(), so this extra step is likely incorrect/confusing. Update the README to remove wit start (or document the correct command if one exists).
| wit start |
|
|
||
| ```bash |
There was a problem hiding this comment.
The init instructions no longer include changing into the target repository (previously cd your-project). Since wit init operates on the current working directory, the README should explicitly tell users to run it from the project root to avoid initializing in the wrong directory.
| ```bash | |
| From the root of the repository you want to coordinate (for example, after `cd your-project`), run: | |
| ```bash | |
| cd your-project # ensure you're in the project root |
Summary
This PR improves the README documentation for this project.
Changes: Improve documentation
This contribution was made as part of an open-source documentation improvement initiative. All changes are meant to be helpful additions to the project.