Update quickstart documentation with new 'Commonly Reported Solutions… #72
Conversation
This file contains 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
|
Added a section for commonly reported solutions to issues that arise when installing MCP. This will increase the value of the documentation by enabling easy access to common solutions. This additional context will provide increased efficiency in troubleshooting. Humans and AI models will benefit from this additional section by giving them pointers for where to look first when troubleshooting common issues. Instead of adding "common issues" which promotes rabbit holes, we call it "common solutions" to promote taking action. |
|
Hey @ctavolazzi, thanks so much for doing this! Overall, this looks great - just added a quick comment about a potential typo. |
zckly
requested changes
Dec 4, 2024
| <Accordion title="Commonly reported solutions"> | ||
| - Verify required packages are up to date (must meet or exceed the MCP requirements) | ||
| - Change the config to use absolute paths (like `C:\\Users\\YOUR_USERNAME\\test.db` or `/Users/YOUR_USERNAME/test.db`) | ||
| - Ensure `coreputils` is enabled (uvx requires it) |
There was a problem hiding this comment.
should this be coreutils instead of coreputils?
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.
Add "Commonly Reported Solutions" section to quickstart guide
Motivation and Context
Added a new section to the troubleshooting guide that addresses frequently reported issues and their solutions, making it easier for new users to resolve common setup problems.
How Has This Been Tested?
Types of changes
Checklist
Additional context
This addition helps reduce common support requests by providing solutions to frequently encountered setup issues upfront.