Skip to content

docs: add Chinese README translations and improve main README formatting #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

appleboy
Copy link

@appleboy appleboy commented May 8, 2025

  • Add links to Traditional and Simplified Chinese README translations at the top of the main README
  • Add new README files in Simplified Chinese and Traditional Chinese, providing full project documentation in both languages
  • Improve code block formatting in the main README by specifying language for code snippets
  • Correct and clarify the formatting of JSON response examples in the main README
  • Update the environment variables table in the main README for better clarity and consistency

Motivation and Context

Support Traditional and Simplified Chinese documentation.

How Has This Been Tested?

No Testing.

Breaking Changes

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

- Add links to Traditional and Simplified Chinese README translations at the top of the English README
- Add code block language specifiers for improved syntax highlighting in documentation
- Correct formatting of JSON response examples in the documentation
- Improve the environment variable configuration table formatting
- Add new README translations in Simplified Chinese and Traditional Chinese

Signed-off-by: Bo-Yi Wu <[email protected]>
@appleboy
Copy link
Author

appleboy commented May 8, 2025

@toby Can you help to review?

appleboy added 2 commits May 25, 2025 14:51
- Refine language and improve clarity throughout the documentation in both Simplified and Traditional Chinese
- Add missing api/ (OpenApi spec) directory entry to the project structure overview
- Update server list and metadata response examples to use UUIDs and include created_at, updated_at, and a count field
- Revamp example server detail and publish request payloads to show more complete, realistic, and structured data, clarifying usage of packages and environment variables
- Add new documentation sections and examples for retrieving server details via API, with example request and response data

Signed-off-by: appleboy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants