Repository navigation
docs(quickapp): lead titles with the capability instead of the feature name - #642
Merged
tanghao-xiaomi merged 1 commit intoAug 4, 2026
Conversation
…e name Retitle the quick app AI Agent tutorial to describe the capability first and keep the API as a code reference: before: openvela 快应用调用 velaclaw(端侧 AI Agent)教程 after: openvela 快应用调用端侧 AI Agent(@system.velaclaw)教程 Prose references to the tutorial in the quick app index and the ai_agent quickstart are updated to match, so the docs refer to it consistently. The code identifiers are deliberately left unchanged, since they are the real API surface that quick apps call: @system.velaclaw, velaclaw.ask(), velaclaw_client_open() and the VELACLAW_DAEMON macro.
tanghao-xiaomi
merged commit Aug 4, 2026
d9680a4
into
open-vela:dev-ai-contest-2026
4 of 5 checks passed
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
Retitle the quick app AI Agent tutorial so the title leads with the capability, and keep the feature name as a code reference:
openvela 快应用调用 velaclaw(端侧 AI Agent)教程openvela 快应用调用端侧 AI Agent(@system.velaclaw)教程Prose references to this tutorial are updated to match, so the docs name it consistently:
quickapp/quickapp_guide_index.md— table link text, plus two prose mentions ("《velaclaw 教程》" -> "《端侧 AI Agent 教程》")ai_hardware/ai_agent_quickstart.md— cross-reference link text; the inline mention now uses the API in code form (@system.velaclaw)Rationale
In a title the bare
velaclawreads as a product/brand name rather than as code, and the title is the most visible and most frequently quoted string in the doc set. Leading with the capability avoids that, while@system.velaclawin parentheses keeps the API discoverable for anyone searching for it.This also matches existing usage in
ai_hardware/ai_hardware_track_guide.md, which already refers to this tutorial as "快应用调用 ai_agent" (that file needs no change).What is NOT changed (intentional)
The code identifiers are the real API surface that quick apps call, so they are left untouched:
@system.velaclaw,velaclaw.ask()velaclaw_client_open()VELACLAW_DAEMONmacroRenaming any of these would break the examples. The filename
quickapp_velaclaw.mdis also kept as-is, since it matches the API name and renaming it would break existing internal and external links.Scope