Apply PR #966 fixes to English and Japanese JSON transcoding documentation #968
+38
−0
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
Co-authored-by: mayuki <9012+mayuki@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Apply the fixes from pull requests to the doc for each language.
Apply PR #966 fixes to English and Japanese JSON transcoding documentation
Jul 30, 2025
mayuki
approved these changes
Jul 30, 2025
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 PR applies the documentation improvements from PR #966 to ensure consistency across all language versions of the JSON transcoding documentation.
Changes Made
Applied to English documentation (
docs/docs/integration/json-transcoding.md):Applied to Japanese documentation (
docs/i18n/ja/docusaurus-plugin-content-docs/current/integration/json-transcoding.md):Background
PR #966 by @gdh2222 added valuable troubleshooting information and clarification to the Korean documentation for JSON transcoding. However, these improvements were only applied to the Korean version, leaving the English and Japanese versions inconsistent and missing important information.
What was added
XML Comments clarification: Added a comment explaining that users must enable the "Generate XML Comments" option in project settings to use the XML documentation feature with Swagger.
Troubleshooting section: Added a comprehensive troubleshooting section that addresses a common runtime exception when using Swagger with MagicOnion, including:
System.AggregateExceptionthat can occurbuilder.Services.AddEndpointsApiExplorer();All three language versions now have consistent content structure and information, with appropriate translations for Japanese text.
Testing
Fixes #967.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.