Skip to content

Conversation

lban2049
Copy link
Contributor

@lban2049 lban2049 commented Aug 22, 2025

Related Issue

https://team.arcblock.io/task/task/612434780847341568

Major Changes

  1. 添加 AIGNE CLI 文档

Screenshots

https://www.staging.arcblock.io/content/docs/aigne-cli/

image

Test Plan

均不适用

Checklist

  • 等 yechao 的 pr merge 之后再 merge 这个 pr
  • framework 我里的文档,我大致看了下好多标题层级都有问题,没有一级标题,可能和上周修改标题层级不要跳跃有关? @LancelotLewis

Summary by AIGNE

Documentation:

  • Added comprehensive documentation infrastructure for AIGNE CLI
  • Established bilingual documentation support (English/Chinese)
  • Created structured navigation system for developer guides

The documentation framework now provides a clear path for developers to learn and use the AIGNE CLI tools, with organized sections covering everything from getting started to advanced integration. This foundation ensures consistent, accessible documentation for both English and Chinese-speaking users.

Copy link

github-actions bot commented Aug 22, 2025

Image description AIGNE CodeSmith

Walkthrough

This change establishes the documentation infrastructure for the AIGNE CLI project by introducing configuration and structure planning files. The setup includes project metadata, audience targeting, multi-language support, and a comprehensive content organization plan that covers everything from basic concepts to advanced integration guides.

Changes

Files Summary
packages/cli/.aigne/doc-smith/config.yaml
packages/cli/.aigne/doc-smith/output/structure-plan.json
Implements documentation foundation with configuration settings (metadata, languages, audience) and content structure planning (navigation, content organization, reference materials)

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description AIGNE CodeSmith

Commits Files that changed from the base of the PR and between 8d97715 and 269b341 commits.
Files selected (2)
  • packages/cli/.aigne/doc-smith/config.yaml (1)
  • packages/cli/.aigne/doc-smith/output/structure-plan.json (1)
Files ignored due to filter (34)
  • packages/cli/docs/_sidebar.md
  • packages/cli/docs/command-reference-built-in-apps.md
  • packages/cli/docs/command-reference-built-in-apps.zh.md
  • packages/cli/docs/command-reference-create.md
  • packages/cli/docs/command-reference-create.zh.md
  • packages/cli/docs/command-reference-hub.md
  • packages/cli/docs/command-reference-hub.zh.md
  • packages/cli/docs/command-reference-observe.md
  • packages/cli/docs/command-reference-observe.zh.md
  • packages/cli/docs/command-reference-run.md
  • packages/cli/docs/command-reference-run.zh.md
  • packages/cli/docs/command-reference-serve-mcp.md
  • packages/cli/docs/command-reference-serve-mcp.zh.md
  • packages/cli/docs/command-reference-test.md
  • packages/cli/docs/command-reference-test.zh.md
  • packages/cli/docs/command-reference.md
  • packages/cli/docs/command-reference.zh.md
  • packages/cli/docs/core-concepts-agents-and-skills.md
  • packages/cli/docs/core-concepts-agents-and-skills.zh.md
  • packages/cli/docs/core-concepts-project-configuration.md
  • packages/cli/docs/core-concepts-project-configuration.zh.md
  • packages/cli/docs/core-concepts.md
  • packages/cli/docs/core-concepts.zh.md
  • packages/cli/docs/getting-started.md
  • packages/cli/docs/getting-started.zh.md
  • packages/cli/docs/guides-creating-a-custom-agent.md
  • packages/cli/docs/guides-creating-a-custom-agent.zh.md
  • packages/cli/docs/guides-running-remote-agents.md
  • packages/cli/docs/guides-running-remote-agents.zh.md
  • packages/cli/docs/guides.md
  • packages/cli/docs/guides.zh.md
  • packages/cli/docs/overview.md
  • packages/cli/docs/overview.zh.md
  • packages/cli/media.md
Files skipped from review due to trivial changes (2)
  • packages/cli/.aigne/doc-smith/config.yaml
  • packages/cli/.aigne/doc-smith/output/structure-plan.json
Review comments generated (0)
  • Review: 0
  • LGTM: 0

提示

Image description AIGNE CodeSmith (@codesmith) 聊天

  • 回复此机器人留下的审查评论以提出后续问题。审查评论是对差异或文件的评论。
  • 通过在回复中标记 @codesmith 邀请机器人加入审查评论链。

代码建议

  • 机器人可能会提出代码建议,但在提交前请仔细审查它们,因为行号范围可能会不对齐。
  • 你可以编辑机器人做出的评论,并在建议稍有偏差时手动调整。

暂停增量审查

  • 在 PR 描述中的任何位置添加 @codesmith: ignore 以暂停机器人的进一步审查。

Copy link

codecov bot commented Aug 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@wangshijun wangshijun changed the title chore: add doc for aigne cli WIP chore: add doc for aigne cli Aug 23, 2025
@skypesky skypesky changed the title WIP chore: add doc for aigne cli chore: add docs publish pipeline and translations Sep 24, 2025
wangshijun
wangshijun previously approved these changes Sep 24, 2025
@li-yechao li-yechao changed the base branch from main to docs-aigne-docs September 30, 2025 01:14
@li-yechao li-yechao changed the base branch from docs-aigne-docs to main September 30, 2025 01:20
@li-yechao li-yechao dismissed wangshijun’s stale review September 30, 2025 01:20

The base branch was changed.

@skypesky skypesky self-requested a review October 13, 2025 07:07
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.

4 participants