Improve readme files#99
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates end-user and contributor documentation to be clearer, more consistent, and better aligned with the extension’s current feature set and installation flow.
Changes:
- Rewrites the root README to focus on features, installation options, and a quick-start flow.
- Refreshes the Client user guide with a structured “Get Started” and expanded feature breakdown.
- Moves/centralizes repository structure + debugging/packaging guidance into CONTRIBUTING.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/Client/README.md |
Refreshes the user guide: clearer onboarding steps, reorganized features, and updated requirements/links. |
README.md |
Refactors the repo landing page to highlight features, install paths, and a brief getting-started checklist. |
CONTRIBUTING.md |
Adds repository structure details and expands debugging/packaging instructions for contributors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mattwar
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.