Add a quick start guide#278
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a Quick Start Guide for the Command Palette GitHub Extension (Preview), covering sign-in, query management, and troubleshooting.
- Added a new
docs/quickstart.mdwith step-by-step instructions and screenshots. - Documented how to view, add, and edit queries, including known issues.
- Included troubleshooting steps for reloading extensions and locating logs.
Comments suppressed due to low confidence (2)
docs/quickstart.md:51
- The link for 'GitHub search syntax' is empty. Please add the URL to the official GitHub search syntax documentation.
* **Query string or URL:** Either the search terms using the [GitHub search syntax]() (e.g. ```repo:microsoft/PowerToys is:issue label:"Product-CommandPalette"```) or the URL for the query on github.com. Use the URL for best results.
docs/quickstart.md:71
- Use inline code formatting (single backticks) for the file path instead of a code block to keep it in-line with the surrounding text.
You can find the extension logs in ```%localappdata%\Packages\Microsoft.CmdPalGitHubExtension_8wekyb3d8bbwe\TempState```.
guimafelipe
previously approved these changes
Jul 11, 2025
cinnamon-msft
previously approved these changes
Jul 15, 2025
cinnamon-msft
left a comment
cinnamon-msft
left a comment
Collaborator
There was a problem hiding this comment.
Just add in that missing link and this looks great! :)
cinnamon-msft
previously approved these changes
Jul 15, 2025
lauren-ciha
force-pushed
the
user/laurenciha/quickstart
branch
from
5217b9c to
395efb7
Compare
cinnamon-msft
approved these changes
Jul 15, 2025
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.
Resolves #263
This pull request adds a comprehensive Quick Start Guide for the Command Palette GitHub Extension (Preview) to the
docs/quickstart.mdfile. The guide provides step-by-step instructions for signing in, viewing and adding queries, editing queries, and troubleshooting common issues.Documentation Enhancements: