Documentation#79
Merged
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request significantly improves the documentation for the project by reorganizing and expanding the
README.mdfile, as well as adding new usage examples for integration with external tools. The main focus is to make it easier for users and developers to navigate the documentation, understand the available features, and get started with various usage scenarios.Key documentation improvements:
Added a detailed, collapsible table of contents to the top of
README.mdfor easier navigation.Improved organization of usage instructions, splitting out Docker usage and adding links to new example usage guides.
Clarified and corrected several descriptions, section titles, and example queries for better readability and accuracy.
New example usage guides:
Added
docs/usage/claude-desktop.mdwith configuration and screenshots for using the server with Claude Desktop.Added
docs/usage/mcpjam.mdwith step-by-step instructions and screenshots for using the server with MCPJam.