Skip to content

Conversation

@alexdewar
Copy link
Collaborator

Description

I meant to do this in #1070, but forgot.

As pointed out by @tsmbland, the information provided in docs/README.md is 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 in docs/README.md. I've removed the information about getting started from the GitHub README.md file and added a link to the docs instead; I think that's a better place for this content.

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copilot AI review requested due to automatic review settings January 14, 2026 11:56
Copy link
Contributor

Copilot AI left a 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.md with detailed getting started information including installation options and links to relevant resources
  • Simplified README.md to 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.

@alexdewar alexdewar requested review from Aurashk and tsmbland January 14, 2026 11:59
@alexdewar alexdewar added this to MUSE Jan 14, 2026
@alexdewar alexdewar moved this to 👀 In review in MUSE Jan 14, 2026
@codecov
Copy link

codecov bot commented Jan 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.09%. Comparing base (5ddf353) to head (9711b3b).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

3 participants