-
Notifications
You must be signed in to change notification settings - Fork 1
Improve README pages #1074
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Improve README pages #1074
Conversation
fbfc51d to
9711b3b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request reorganizes README documentation to improve the getting started experience for new users. The changes move detailed installation and getting started information from the GitHub README to the documentation README, making the docs more comprehensive while keeping the GitHub README more focused.
Changes:
- Enhanced
docs/README.mdwith detailed getting started information including installation options and links to relevant resources - Simplified
README.mdto provide a high-level overview and direct users to the documentation for getting started details - Moved the warning about MUSE2's current limitations to a more prominent location in both READMEs
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/README.md |
Expanded with comprehensive getting started section including installation instructions, development setup, and links to user/developer guides |
README.md |
Streamlined to remove detailed getting started instructions and redirect users to documentation; reorganized overview section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1074 +/- ##
=======================================
Coverage 82.09% 82.09%
=======================================
Files 53 53
Lines 7310 7310
Branches 7310 7310
=======================================
Hits 6001 6001
Misses 1019 1019
Partials 290 290 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Description
I meant to do this in #1070, but forgot.
As pointed out by @tsmbland, the information provided in
docs/README.mdis currently a bit sparse (e.g. it doesn't tell users how to install MUSE2), which isn't ideal as it's the first page some users may land on. I've reworked things a bit to provide more information on getting started indocs/README.md. I've removed the information about getting started from the GitHubREADME.mdfile and added a link to the docs instead; I think that's a better place for this content.Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks