docs: add AI-assisted setup option to quick start guide#516
Merged
tanghao-xiaomi merged 3 commits intoopen-vela:devfrom Apr 16, 2026
Merged
docs: add AI-assisted setup option to quick start guide#516tanghao-xiaomi merged 3 commits intoopen-vela:devfrom
tanghao-xiaomi merged 3 commits intoopen-vela:devfrom
Conversation
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>
yanxingyu17
requested review from
TangMeng12,
aiduxiaoxiong,
smile0425 and
tanghao-xiaomi
as code owners
TangMeng12
approved these changes
Apr 16, 2026
tanghao-xiaomi
approved these changes
Apr 16, 2026
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
3 participants
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
Add AI-assisted setup option to the Ubuntu quick start guide and project READMEs, pointing developers to the
openvela-quickstartskill in the .claude repository.Changes
Why
The manual setup process involves 4 steps with many decision points (SSH vs HTTPS, Gitee vs GitHub vs GitCode, dev vs trunk). New developers frequently encounter issues like SSH auth failures, Google source access, Git LFS corruption, OOM, and Kconfig errors.
The openvela-quickstart skill automates the entire flow and provides targeted troubleshooting when issues arise. Adding a visible entry point in the existing docs lets developers discover this option without changing the manual guide structure.
Related PR