Skip to content

docs: reference orphaned A2DP and Feature Context figures#537

Merged
TangMeng12 merged 1 commit into
open-vela:devfrom
tanghao-xiaomi:reference-orphan-api-images
May 9, 2026
Merged

docs: reference orphaned A2DP and Feature Context figures#537
TangMeng12 merged 1 commit into
open-vela:devfrom
tanghao-xiaomi:reference-orphan-api-images

Conversation

@tanghao-xiaomi
Copy link
Copy Markdown
Collaborator

Summary

Two figures previously shipped with the API reference were not referenced by any document. Instead of deleting them, this PR adds proper references so each figure contributes to the documentation.

Changes

Figures that were orphaned

  • docs/zh-cn/api/framework/bluetooth/figures/a2dp.png — A2DP connection state machine diagram.
  • docs/zh-cn/api/framework/feature/figures/ft_context.svg — Relationship between the Feature framework interface (ft_value_t / ft_context_ref) and the frontend runtime (JSValue / JSContext).

New references added

  • bt_a2dp.md: Added a new Connection State Machine section between the implementation notes and the synchronous interfaces. The section renders the A2DP state machine diagram and explains each state (Idle, Opening, Opened, Started, Closing).
  • feature_framework_context.md: Added a new Feature Context and Frontend Runtime section that uses ft_context.svg to explain how ft_value_t / ft_context_ref map onto JSValue / JSContext in the QuickJS implementation, and how switching frontends keeps the Feature implementation code stable.

Both Chinese and English versions are kept in sync.

Stats

  • 4 files changed
  • +50 lines / -0 lines

Testing

Documentation-only change. Verified:

  • Each image is now referenced by exactly one markdown file per language.
  • No remaining orphan images in docs/zh-cn/api/ or docs/en/api/.
  • Relative paths (figures/a2dp.png, figures/ft_context.svg) resolve correctly from the referring .md files.

Two figures previously shipped with the API reference were not referenced
by any document:

- figures/a2dp.png (under framework/bluetooth/) — A2DP connection state
  machine diagram.
- figures/ft_context.svg (under framework/feature/) — Relationship between
  the Feature framework interface (ft_value_t / ft_context_ref) and the
  frontend runtime (JSValue / JSContext).

Instead of deleting them, both figures are now properly referenced:

- bt_a2dp.md gains a new 'Connection State Machine' section that renders
  the A2DP state machine diagram with a description of each state.
- feature_framework_context.md gains a new 'Feature Context and Frontend
  Runtime' section that uses ft_context.svg to explain the value/context
  mapping between the Feature framework and frontend runtimes.

Chinese and English versions are kept in sync.
@TangMeng12 TangMeng12 merged commit ff8c2f9 into open-vela:dev May 9, 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.

3 participants