Refine documentation and translations for graphics API terminology - #38
Merged
Merged
Conversation
…iple language files
…rocess - Updated instructions for describing code samples to include visible results and main techniques demonstrated. - Clarified the importance of prerequisites for running samples and emphasized the exclusion of unrelated details. - Enhanced the content review process to focus on reading order, teaching sequence, and continuity, while separating editorial findings from technical checks.
- Improved clarity and accuracy in Portuguese (pt-BR) localization, including adjustments to rendering resource management and shader compilation descriptions. - Enhanced Russian (ru-RU) translations for rendering resource ownership and shader compilation, ensuring consistency in technical terminology. - Refined Chinese (Simplified) (zh-CN) strings for rendering resource management and shader compilation descriptions, improving readability and technical accuracy. - Updated Chinese (Traditional) (zh-TW) localization, correcting terminology related to rendering resources and shader compilation, and ensuring consistency across the document. - Minor adjustments in the translation guidelines for Chinese (Traditional) to clarify distinctions in resource usage and memory management concepts.
…ns of features and getting started instructions
…rce management and shader compilation
…d context - Added translation for "graphics API / implementation" in zh-CN and zh-TW locales. - Updated various descriptions in zh-TW strings.yml to clarify graphics API references. - Revised maintenance.md to specify graphics API terminology and improve clarity on windowing library and graphics API selection.
…erms - Updated Russian translation to specify DirectX 12, Metal 4, and Vulkan 1.4 as graphics APIs. - Revised Chinese (Simplified) strings to clarify descriptions and improve terminology consistency, including updates to graphics API references. - Enhanced Chinese (Traditional) translations for clarity and consistency, particularly in descriptions of graphics APIs and integration details. - Modified maintenance documentation to emphasize the use of full graphics API versions and clarify the description of packages as implementations of the shared API. - Adjusted search template to reflect the change from "source code" to "code examples" for better clarity in search results.
…clarity and consistency - Refined translations for integration details, surface details, resource allocation, shader binding, and synchronization guidance to enhance readability and technical accuracy. - Adjusted terminology to ensure consistency across both Simplified and Traditional Chinese versions. - Improved descriptions in tutorials and requirements sections for better understanding of graphics API usage and project setup.
…documentation - Standardized quotation marks in localization strings for consistency. - Updated various terminology in the translation document to improve clarity and accuracy, including terms related to graphics API, rendering, and shader concepts.
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Restore the Skia integration/native-assets prerequisite to the InkCanvas catalog entry.
Review effort: Lite
Findings: None
What changed in this PR
Refines Zenith.NET graphics API documentation, terminology, tutorials, samples, and translations.
Changes:
- Updates project, package, search, maintenance, and API-version documentation.
- Simplifies tutorials and the samples catalog.
- Aligns localized terminology and documentation strings.
| File | Reviewed change |
|---|---|
README.md |
Updates project overview, links, packages, and API descriptions. |
documents/templates/partials/site.search.tmpl.partial |
Renames the samples search label. |
documents/maintenance.md |
Refreshes terminology and editorial guidance. |
documents/locales/zh-TW/translation.md |
Updates Traditional Chinese terminology. |
documents/locales/zh-CN/translation.md |
Updates Simplified Chinese terminology. |
documents/locales/zh-CN/strings.yml |
Revises Simplified Chinese documentation strings. |
documents/locales/ru-RU/translation.md |
Adds graphics API terminology. |
documents/locales/pt-BR/translation.md |
Updates Brazilian Portuguese terminology. |
documents/locales/ko-KR/translation.md |
Adds Korean graphics API terminology. |
documents/locales/ja-JP/translation.md |
Adds Japanese graphics API terminology. |
documents/locales/fr-FR/translation.md |
Adds French graphics API terminology. |
documents/locales/fr-FR/strings.yml |
Revises French documentation strings. |
documents/locales/es-ES/translation.md |
Adds Spanish graphics API terminology. |
documents/locales/en-US/strings.yml |
Revises canonical strings; the InkCanvas entry should retain its Skia prerequisite. |
documents/locales/de-DE/translation.md |
Adds German graphics API terminology. |
documents/locales/de-DE/strings.yml |
Revises German documentation strings. |
documents/learn/samples.md |
Streamlines the samples catalog. |
documents/learn/first-triangle.md |
Simplifies tutorial structure and lifecycle guidance. |
documents/learn/concepts/shader-data-and-binding.md |
Updates shader output terminology and bindings. |
documents/learn/concepts/resource-management.md |
Adds texture transfer layout guidance. |
documents/learn/concepts/platform-integration.md |
Removes redundant integration guidance. |
documents/index.md |
Updates displayed graphics API versions. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Upgraded package version to 1.1.0 for stable release. Updated description to highlight cross-platform support and shared C# API. Replaced tags with more relevant keywords: "RHI;Graphics;GPU;Rendering;CSharp".
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
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.
Summary
Validation
docfx build documents/docfx.json --warningsAsErrorspassed with 0 warnings and 0 errors.git diff --check origin/master...HEADpassed.Review focus