Simplify startup shortcut instructions in README#72
Merged
Conversation
Removed redundant text about launching the CLI in Plan mode.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR simplifies the Plan mode “startup shortcut” section in the getting-started documentation by removing extra phrasing and shortening the example invocation.
Changes:
- Shortened the “Startup shortcut” tip text for launching directly into Plan mode.
- Simplified the example command from a one-liner with a prompt to
copilot --plan.
Show a summary per file
| File | Description |
|---|---|
| 01-setup-and-first-steps/README.md | Streamlines the Plan mode startup shortcut explanation and example command. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
Comment on lines
+279
to
282
| > 💡 **Startup shortcut**: You can launch the CLI directly in Plan mode from your terminal using the `--plan` flag. | ||
| > ```bash | ||
| > copilot --plan "Add a mark as read command to the book app" | ||
| > copilot --plan | ||
| > ``` |
There was a problem hiding this comment.
The startup shortcut example (copilot --plan) doesn’t show what the user should type next to actually create a plan. Consider either keeping the previous one-liner with an example prompt, or extending the snippet to include the first prompt entered after startup so readers can see the intended flow.
See below for a potential fix:
> 💡 **Startup shortcut**: You can launch the CLI directly in Plan mode from your terminal using the `--plan` flag, then enter your planning request:
> ```bash
> copilot --plan
>
> > Add a "mark as read" command to the book app
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.
Removed redundant text about launching the CLI in Plan mode.