docs: improve documentation clarity and client integration steps #567
+40
−36
Conversation
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
Contributor
appleboy
commented
Oct 10, 2025
appleboy
commented
- Fix typo in "TroubleShooting" heading, changing it to "Troubleshooting"
- Improve CLI usage instructions by formatting commands as code blocks and marking them with "bash"
- Change "Start the Server" to a third-level heading for clarity
- Add additional code examples for real-world client testing and interaction steps
- Clarify and condense instructions for adding the tool to a popular MCP client
findleyr
reviewed
Oct 10, 2025
README.md
Outdated
| "context" | ||
| "log" | ||
| "os/exec" | ||
| "context" |
Contributor
There was a problem hiding this comment.
This change from tabs to spaces seems incorrect. Code code should be indented with tabs, and that is (or should be) the case for all other examples.
Contributor
Author
There was a problem hiding this comment.
I will revert the section.
Contributor
Author
Contributor
|
The CI failure is confusing, sorry. I sent #568 to fix it. We generate parts of our README, so you need to modify |
- Fix typo in "TroubleShooting" heading, changing it to "Troubleshooting" - Improve CLI usage instructions by formatting commands as code blocks and marking them with "bash" - Change "Start the Server" to a third-level heading for clarity - Add additional code examples for real-world client testing and interaction steps - Clarify and condense instructions for adding the tool to a popular MCP client Signed-off-by: appleboy <[email protected]>
- No changes to summarize; the diff is empty. Signed-off-by: appleboy <[email protected]>
- Capitalize the "TroubleShooting" heading for consistency with title case formatting Signed-off-by: appleboy <[email protected]>
Contributor
Author
findleyr
approved these changes
Oct 11, 2025
Contributor
|
(need another reviewer as I resolved merge conflicts) |
Contributor
Author
|
@findleyr Thanks. |
jba
approved these changes
Oct 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.