Streamline README: trim redundant sections, improve CLI presentation#130
Merged
TianqiZhang merged 1 commit intoMicrosoftDocs:mainfrom Mar 17, 2026
Merged
Conversation
- Simplify Example Prompts to 4 clean examples without instructional text - Remove Key Capabilities section (duplicates tools table) - Remove Getting Started steps (redundant with install table) - Remove Future Enhancements section (vague, no user value) - Add preview label and npm badge to CLI section - Fix code block language markers (bash -> sh, remove bash from plugin commands) - Clarify --json flag description Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the repository’s top-level documentation by simplifying the “Example Prompts” section and refreshing the Microsoft Learn CLI documentation to better match current usage.
Changes:
- Condensed the “Example Prompts” section into a shorter list of representative prompts.
- Updated the Microsoft Learn CLI section (adds an npm version badge, labels it as
preview, refreshes command examples, and clarifies--jsonoutput wording). - Removed the “Getting Started” and “Future Enhancements” sections from the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pdebruin
approved these changes
Mar 17, 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.
Summary
previewlabel and npm version badge to CLI sectionbash→shfor shell commands, plain fences for plugin commands)--jsonflag descriptionNet: -50 lines, +14 lines. The README is shorter, less repetitive, and puts the CLI in a better light.
Test plan
🤖 Generated with Claude Code