Fix incomplete/broken translations across media, bluetooth, and network
API documentation where Chinese and English were mixed together in
function descriptions, parameter explanations, and return values.
Changes:
- media: media_player, media_recorder, media_session, media_policy
- bluetooth: bt_a2dp, bt_hfp, bt_spp, bt_gap, bt_hid
- network: wapi
- media_utils: add missing media_player_dump and media_recorder_dump APIs (zh-cn + en)
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.
- Add en/release_notes/v5.5.md and zh-cn/release_notes/v5.5.md
- Cover kernel / bluetooth / connectivity / multimedia / graphics /
system services / security / QuickApp / AI Agent new features,
breaking changes and upgrade guide
- Link both versions from top-level README.md and README_zh-cn.md
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.
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.
Previously openvela API documentation was built via Doxygen + Breathe + Sphinx,
requiring a complex toolchain and generating 180MB of intermediate artifacts.
Since all module-level API documentation (kernel, bluetooth, media, telephony,
feature, etc.) has been refactored to hand-written Markdown, the toolchain is
no longer necessary.
This commit deprecates the Sphinx/Doxygen build pipeline in favor of pure
Markdown browsing on GitHub.
Removed:
- Doxyfile.public (Doxygen config, 113KB)
- conf.py / Makefile / make.bat / requirements.txt / index.rst (Sphinx config)
- _static/logo/openvela.svg (Sphinx static asset)
- api_doc_generation_guide.md in both zh-cn/ and en/ (Doxygen+Sphinx tutorials)
Updated:
- All index.md files: removed 'eval_rst toctree' blocks, added plain
Markdown navigation lists
- keystore_client.md: removed doxygenfile directive (placeholder note added
pointing to source header, pending full rewrite)
Added:
- .gitignore: prevent accidental commit of build artifacts (_build/,
doxygen/doxygen/, Python/editor temp files)
Follow-up:
- services/ams.md and services/pms.md still contain doxygenfile directives
and need full manual rewrite (separate PR)
- .github/workflows/docs.yml may need to be updated or removed to stop
invoking the deprecated Sphinx build
openvela does not currently support macOS as a build host.
Remove macOS quick start documents (zh-cn and en) and the
related FAQ entry (#16) about macOS simulator issues.
Renumber subsequent FAQ entries to maintain continuity.
Add an AI-assisted setup option using the openvela-quickstart skill from
the .claude repository. This provides an automated alternative to the
manual setup steps, covering environment detection, dependency
installation, repository initialization, build, and emulator launch.
Changes:
- zh-cn/quickstart/openvela_ubuntu_quick_start.md: Add AI tip block
- en/quickstart/openvela_ubuntu_quick_start.md: Add AI tip block
- README_zh-cn.md: Add AI quickstart link in Quick Start section
- README.md: Add AI quickstart link in Quick Start section
Signed-off-by: yanxingyu17 <yanxingyu17@gmail.com>
zhangxiaowei16
v-tangmeng
yanxingyu17