docs: Add documentation for mcpm share command #165
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
This commit introduces documentation for the `mcpm share` command in the following places: - README.md: Added a new section explaining the command, its options, and usage examples. - README.zh-CN.md: Added a corresponding translated section. - pages/index.html: Added a new section to the website describing the command and its usage, consistent with other documented commands. The `mcpm share` command allows you to expose a local MCP server (given by a shell command) to a public URL by using `mcp-proxy` and creating a tunnel.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation for the "mcpm share" command by adding detailed sections across the website and project documentation to explain its usage, options, and examples.
- Added a new section in pages/index.html to showcase the command visually on the website.
- Updated README.md with a comprehensive overview and usage examples.
- Updated README.zh-CN.md with a translated section reflecting the same information.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pages/index.html | Added HTML section with share command details and usage examples. |
| README.zh-CN.md | Inserted a translated documentation block describing the share command. |
| README.md | Added documentation section for the share command with options and examples. |
|
🎉 This PR is included in version 1.13.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
This commit introduces documentation for the
mcpm sharecommand in the following places:The
mcpm sharecommand allows you to expose a local MCP server (given by a shell command) to a public URL by usingmcp-proxyand creating a tunnel.