Skip to content

docs: translate figures in en/api and prune low-value figures#540

Merged
TangMeng12 merged 1 commit into
open-vela:devfrom
tanghao-xiaomi:translate-en-figures
May 11, 2026
Merged

docs: translate figures in en/api and prune low-value figures#540
TangMeng12 merged 1 commit into
open-vela:devfrom
tanghao-xiaomi:translate-en-figures

Conversation

@tanghao-xiaomi
Copy link
Copy Markdown
Collaborator

Summary

The English API reference previously embedded Chinese figures under docs/en/api/. This PR makes the English documentation self-consistent by either replacing the figures with translated English versions, or removing low-value figures and expressing the same information inline.

Changes

Figures translated (English versions replaced)

Each of the following docs/en/api/.../figures/*.png images has been updated with an English translation (Chinese version under docs/zh-cn/ is kept unchanged):

Figure Purpose
framework/feature/figures/JIDL.png JIDL workflow
framework/feature/figures/feature_static.png Static concept model of Module / Prototype / Instance
framework/feature/figures/feature_instance.png Relationship between handles and prototypes/instances
framework/feature/figures/Asynchronous_model.png uvloop + worker queue model
framework/telephony/figures/TapiWork.png TAPI working sequence

Figures pruned (removed in both en/ and zh-cn/)

The following figures conveyed limited information beyond what the surrounding text already expressed. They have been removed from both language trees, and the same information is now rendered inline as concise text or tables:

Figure Replacement
feature_framework.png short bullet list of the architecture layers
feature_life.png a full table documenting each lifecycle event (trigger + notes)
feature_running.png bullet list describing Module / Prototype / Instance semantics
callback_promise_manager.png inline description of the internal ID / table design
quickapp/basic_structure.png Overall Architecture section removed; its information is already covered by the Related Documentation links

Markdown documents touched:

  • docs/en/api/framework/feature/feature_framework.md
  • docs/en/api/framework/quickapp/basic.md
  • docs/zh-cn/api/framework/feature/feature_framework.md
  • docs/zh-cn/api/framework/quickapp/basic.md

Verification

  • Every image reference in the touched .md files points at a real file (no dead links).
  • No orphaned image files remain under docs/en/api/ or docs/zh-cn/api/.
  • Chinese and English versions stay structurally symmetric: both delete the same 5 figures, and the surrounding prose additions are translations of each other.

Stats

  • 19 files changed
  • +56 / -28 lines

Testing

Documentation-only change; no runtime tests needed.

Replace Chinese figures under docs/en/api/ with English translations so
the English documentation no longer embeds Chinese-only images.

Figures translated (docs/en/api/...):
- framework/feature/figures/JIDL.png
- framework/feature/figures/feature_static.png
- framework/feature/figures/feature_instance.png
- framework/feature/figures/Asynchronous_model.png
- framework/telephony/figures/TapiWork.png

Figures pruned (removed in both en/ and zh-cn/) and expressed inline via
concise text or tables, which carries the same information more compactly:
- feature_framework.png: use a short bullet list of the architecture layers.
- feature_life.png: use a table documenting each lifecycle event.
- feature_running.png: use a bullet list describing Module / Prototype /
  Instance semantics.
- callback_promise_manager.png: describe the internal ID/table design inline.
- quickapp/basic_structure.png: remove the Overall Architecture section,
  whose information is already covered by Related Documentation links.
@TangMeng12 TangMeng12 merged commit 37924fe into open-vela:dev May 11, 2026
4 checks passed
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.

4 participants