Refactor README to remove duplicate documentation - #204
Open
Jim Daly (JimDaly) wants to merge 3 commits into
Open
Refactor README to remove duplicate documentation#204Jim Daly (JimDaly) wants to merge 3 commits into
Jim Daly (JimDaly) wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-only and low risk, with only minor Markdown/wording consistency fixes suggested.
Pull request overview
This PR refactors the repository README to remove in-README “getting started/usage” documentation and instead point readers to Microsoft Learn documentation and the repo’s examples/ directory, keeping the README focused on discovery and contribution.
Changes:
- Replaces the detailed “Key features / Getting started / Usage” content with curated links to learn.microsoft.com docs.
- Simplifies the Table of contents to three high-level entry points: Learn, Samples, Contribute.
- Keeps samples and contribution guidance as the primary on-repo onboarding paths.
File summaries
| File | Description |
|---|---|
| README.md | Removes duplicated usage documentation and replaces it with Microsoft Learn links; keeps samples/contribution sections prominent. |
Review details
Suppressed comments (2)
README.md:32
- This section is a top-level topic (it appears in the README TOC), but it's currently an H3 heading. To keep heading hierarchy consistent with other top-level sections (and improve navigation), make it an H2 heading.
### Sample code
README.md:36
- "Contribute" is listed as a top-level entry in the Table of contents, but the heading is currently H3. Promoting it to H2 keeps the outline consistent with the rest of the README (e.g., "## Trademarks").
### Contribute
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
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.
Replacing duplicate documentation with links to documentation on learn.microsoft.com.
The scope of this README should not be a quick start. Quick Starts should be on learn.microsoft.com.
People should come to this project for sample code and to contribute to the project.