docs: add English translation for API reference documentation#536
Merged
Conversation
0bb216e to
4239bca
Compare
Add full English version of API reference docs under docs/en/api/, covering 69 files across kernel, framework, and network modules. Additional changes in docs/zh-cn/api/: - Add bilingual navigation header to all 69 zh-cn API documents, enabling cross-language switching between Chinese and English versions. - Fix 16 mis-placed function descriptions in telephony/telephony_call.md where multiple APIs incorrectly shared the same description (re-derived from the tapi_call.h header @brief comments). - Fix 2 untranslated English residues in network/wapi.md.
4239bca to
d32fb44
Compare
yanxingyu17
approved these changes
May 9, 2026
TangMeng12
approved these changes
May 9, 2026
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
This PR adds a complete English version of the openvela API reference documentation and improves the existing Chinese version.
Changes
Added
docs/en/api/— English translation of the API reference, 69 files in total, covering the kernel, framework, and network modules.\[ English | [简体中文](...) \]Modified (
docs/zh-cn/api/)\[ [English](...) | 简体中文 \]to all 69 Chinese files, enabling bidirectional navigation between the two languages.framework/telephony/telephony_call.md: Fixed 16 mis-placed function descriptions. In the original Chinese document, multiple unrelated APIs incorrectly shared the same description (a batch-copy mistake). Descriptions have been re-derived from the@briefcomments in thetapi_call.hheader, and the English version has been updated in sync.network/wapi.md: Fixed 2 places where English text had been left untranslated.Coverage
Quality Checks
The following automated checks were run before committing:
**参数**or**返回值**tapi_contextmapped toTelephony context handle,p_handlemapped toAsynchronous callback function)Testing
Documentation-only change; no runtime testing required. All files pass the local validation scripts.
Stats