Commit Graph

3 Commits

Author SHA1 Message Date
zhangxiaowei16 37924fe937 docs: translate figures in en/api and prune low-value figures
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.
2026-05-11 13:58:40 +08:00
zhangxiaowei16 4071012159 docs: add English translation for API reference documentation
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.
2026-05-09 16:44:23 +08:00
zhangxiaowei16 a5b62d432b docs: move doxygen/ to zh-cn/api and zh-cn/device_dev_guide
Reorganize the legacy docs/doxygen/ directory so that file locations
match both the actual content type and the existing bilingual docs
layout (zh-cn/ for Chinese, en/ for English).

== Why ==

Since #526 deprecated the Sphinx/Doxygen build pipeline, all files
under docs/doxygen/ are plain hand-written Markdown. The directory
name is misleading, and the content is currently Chinese-only while
the rest of docs/ uses docs/zh-cn and docs/en mirrors.

The directory also mixed two unrelated content types:
- docs/doxygen/api/              — API reference
- docs/doxygen/system_debug_tools/ — Chinese developer guides

== What ==

- git mv docs/doxygen/api → docs/zh-cn/api (81 files)
- git mv docs/doxygen/system_debug_tools → docs/zh-cn/device_dev_guide/system_debug_tools (20 files)
- rmdir docs/doxygen (now empty)

Pure rename / move; no content changes. 'grep -rn doxygen/' over the
remaining Markdown and YAML returns no hits.

== Notes ==

- API documentation is now at docs/zh-cn/api/, consistent with the rest
  of the Chinese docs tree. The English mirror at docs/en/api/ will be
  added in a follow-up PR once translations are ready.
- system_debug_tools/ joins the existing Chinese dev-guide tree
  alongside kernel/, driver/, connection/, media/, etc.
- The system_debug_tools/ files are currently wrapped in Doxygen-style
  comment blocks; that formatting issue is tracked as a separate
  cleanup task and is not addressed here.
2026-05-09 13:59:07 +08:00