fix(readme): fix all readme files typos (#47)

Author: YumengBao

.markdownlint-cli2.jsonc

@@ -0,0 +1,23 @@
+{
+  "customRules": [
+    "markdownlint-rules/required-headers.js"
+    // "markdownlint-rules/result-section-has-image.js"
+  ],
+  "globs": [
+    "01-tutorials/**/README.md",
+    "02-use-cases/**/README.md"
+  ],
+  "ignores": [
+    "01-tutorials/workshop/README.md",
+    "01-tutorials/README.md",
+    "02-use-cases/beginner/README.md"
+  ],
+  "config": {
+    // allow HTML
+    "MD033": false,
+    // disable line length check
+    "MD013": false,
+    // allow multiple headers with the same content
+    "MD024": false
+  }
+}

.pre-commit-config.yaml

@@ -14,14 +14,12 @@ repos:
   rev: v8.24.2
   hooks:
     - id: gitleaks
-# - repo: local
-#   hooks:
-#     - id: markdownlint-cli2
-#       name: markdownlint-cli2
-#       entry: npx
-#       args:
-#         - markdownlint-cli2
-#         - "**/*.md"
-#       language: system
-#       pass_filenames: true
-#       types: [markdown]
+- repo: local
+  hooks:
+    - id: markdownlint-cli2
+      name: markdownlint-cli2
+      entry: npx
+      args:
+        - markdownlint-cli2
+      language: system
+      pass_filenames: false

01-tutorials/workshop/README.md

@@ -1 +0,0 @@
-

01-tutorials/workshop/session4/README.md

@@ -1 +1,93 @@
+# Session 4
 
+## 概述
+
+本项目为 Agentkit Sample 的模板工程，用来帮助您创建规范、标准的 Agent 样例，并能帮助用户快速部署到 AgentKit 平台。
+
+## 核心功能
+
+- 功能 1
+- 功能 2
+
+## Agent 能力
+
+请根据您的 Agent 能力，在下方描述主要的火山引擎产品或 Agent 组件：
+
+- 豆包大模型 / Seedance / Seedream
+- 知识库
+- 记忆库
+- 内置工具
+- 自定义工具
+- Identity
+- ...
+
+## 目录结构说明
+
+您应当在此详细说明每个目录的作用，以及其中包含的文件。
+
+## 本地运行
+
+### 前置准备
+
+引导用户开通火山引擎相关服务、开通某模型权限等。如无需前置准备，同样需在此处标明。
+
+### 依赖安装
+
+您可以通过 `pip` 工具来安装本项目依赖：
+
+```bash
+pip install -r requirements.txt
+```
+
+或者使用 `uv` 工具来安装本项目依赖：
+
+```bash
+# 使用 `pyproject.toml` 管理依赖
+uv sync
+
+# 使用 `requirements.txt` 管理依赖
+uv pip install -r requirements.txt
+```
+
+### 环境准备
+
+说明您的环境配置文件中的具体内容。
+
+### 调试方法
+
+通常使用 `python` 来运行项目：
+
+```bash
+python ...
+```
+
+或者使用 `veadk web` 进行调试：
+
+```bash
+veadk web
+```
+
+## AgentKit 部署
+
+您需要在此详细说明如何将本项目部署到 AgentKit 平台。
+
+## 示例提示词
+
+- 提示词 1
+- 提示词 2
+- ...
+
+## 效果展示
+
+您需要在此处展示项目的运行效果，例如截图、视频等。
+
+您的截图、视频等素材资产应当放置于 `assets` 目录下。
+
+## 常见问题
+
+- 问题 1
+- 问题 2
+
+## 代码许可
+
+本工程遵循 Apache 2.0 License

02-use-cases/ai_coding/README.md

@@ -1,7 +1,9 @@
 # AI Coding Agent - 智能编程助手
+
 这是一个基于火山引擎AgentKit构建的智能编程助手系统，专门用于帮助用户解决各类编程问题。系统集成了代码执行沙箱、TOS对象存储服务功能，能够提供专业、高效的编程辅助体验。
 
 ## 概述
+
 本用例展示如何构建一个生产级 AI 编程助手系统，具备以下能力:
 
 - **智能编程对话**：基于AI的智能编程助手，能够理解用户编程需求并提供准确代码解决方案
@@ -11,12 +13,11 @@
 - **长期记忆**：支持会话记忆和用户历史记录存储
 - **观测能力**：集成OpenTelemetry追踪和APMPlus监控
 
-## 架构
-### 系统架构
+## 核心功能
 
 ![AI Coding Agent with AgentKit Runtime](img/archtecture_ai_coding.jpg)
 
-```
+```text
 用户请求
     ↓
 AgentKit 运行时
@@ -27,29 +28,55 @@ AI 编程助手
     └── URL 生成工具 (get_url_of_frontend_code_in_tos)
 ```
 
-### 核心组件
+## Agent 能力
 
 | 组件 | 描述 |
-|-----------|-------------|
+| - | - |
 | **Agent 服务** | [`agent.py`](agent.py) - 主智能体应用,包含配置和运行逻辑 |
 | **工具模块** | [`tools.py`](tools.py) - TOS 上传、URL 生成和实用工具函数 |
 | **沙箱执行** | 支持 Python、Java、JavaScript、Go 的安全代码执行环境 |
 | **TOS 集成** | 用于托管前端代码并提供公共访问的对象存储服务 |
 
-## 快速开始
+### 多语言支持
+
+支持 Python、Java、JavaScript、Go 等主流编程语言,具备自动语法验证。
+
+### 沙箱执行
+
+在隔离环境中运行代码,确保安全性并防止系统干扰。
+
+### 自动化部署
+
+前端代码自动上传到 TOS,生成预览 URL 以便立即测试。
+
+### 可观测性
+
+内置 OpenTelemetry 追踪和 APMPlus 监控,支持生产环境调试和性能分析。
+
+## 目录结构说明
+
+```text
+ai_coding/
+├── agent.py              # 主智能体应用及配置
+├── tools.py              # 工具函数 (TOS 上传、URL 生成)
+├── requirements.txt      # Python 依赖
+└── README.md            # 项目文档
+```
+
+## 本地运行
 
 ### 前置条件
 
-**1. 火山引擎访问凭证**
+#### 火山引擎访问凭证
 
 1. 登录 [火山引擎控制台](https://console.volcengine.com)
 2. 进入"访问控制" → "用户" -> 新建用户 或 搜索已有用户名 -> 点击用户名进入"用户详情" -> 进入"密钥" -> 新建密钥 或 复制已有的 AK/SK
    - 如下图所示
    ![Volcengine AK/SK Management](../img/volcengine_aksk.jpg)
 3. 为用户配置 AgentKit运行所依赖服务的访问权限:
    - 在"用户详情"页面 -> 进入"权限" -> 点击"添加权限"，将以下策略授权给用户
-    - `AgentKitFullAccess`（AgentKit 全量权限）
-    - `APMPlusServerFullAccess`（APMPlus 全量权限）
+   - `AgentKitFullAccess`（AgentKit 全量权限）
+   - `APMPlusServerFullAccess`（APMPlus 全量权限）
 4. 为用户获取火山方舟模型 Agent API Key
    - 登陆[火山方舟控制台](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0&briefType=introduce&type=new)
    - 进入"API Key管理" -> 创建 或 复制已有的 API Key，后续`MODEL_AGENT_API_KEY`环境变量需要配置为该值
@@ -65,7 +92,7 @@ AI 编程助手
    - 如下图所示
    ![Ark Model Service Management](../img/ark_model_service_management.jpg)
 
-**2. AgentKit 工具 ID**
+#### AgentKit 工具 ID
 
 1. 登录火山引擎 AgentKit 控制台
 2. 进入"工具" → "创建沙箱工具"
@@ -108,18 +135,20 @@ export MODEL_AGENT_API_KEY={{your_model_agent_api_key}} # 从火山方舟获取
 ```
 
 **环境变量说明:**
+
 - `VOLCENGINE_ACCESS_KEY`: 火山引擎访问凭证的 Access Key
 - `VOLCENGINE_SECRET_KEY`: 火山引擎访问凭证的 Secret Key
 - `DATABASE_TOS_BUCKET`: 用于存储生成的前端代码的 TOS 存储桶名称
-    - 格式: `DATABASE_TOS_BUCKET=agentkit-platform-{{your_account_id}}`
-    - 示例: `DATABASE_TOS_BUCKET=agentkit-platform-12345678901234567890`
-    - 其中`{{your_account_id}}`需要替换为您的火山引擎账号 ID
+  - 格式: `DATABASE_TOS_BUCKET=agentkit-platform-{{your_account_id}}`
+  - 示例: `DATABASE_TOS_BUCKET=agentkit-platform-12345678901234567890`
+  - 其中`{{your_account_id}}`需要替换为您的火山引擎账号 ID
 - `AGENTKIT_TOOL_ID`: 从 AgentKit 控制台获取的工具 ID
 - `MODEL_AGENT_API_KEY`: 从火山方舟获取的模型 Agent API Key
 
-## 本地测试
+## 测试
 
 使用 `veadk web` 进行本地调试:
+
 > `veadk web`是一个基于 FastAPI 的 Web 服务，用于调试 Agent 应用。运行该命令时，会启动一个web服务器，这个服务器会加载并运行您的 agentkit 智能体代码，同时提供一个聊天界面，您可以在聊天界面与智能体进行交互。在界面的侧边栏或特定面板中，您可以查看智能体运行的细节，包括思考过程（Thought Process）、工具调用（Tool calls）、模型输入/输出。
 
 ```bash
@@ -146,7 +175,7 @@ veadk web
 - **Python 代码生成**: "写一个生成斐波那契数列的函数"
 - **算法实现**: "用 Python 创建一个二分查找实现"
 
-## 部署
+## AgentKit 部署
 
 1. 部署到火山引擎 AgentKit Runtime:
 
@@ -165,52 +194,44 @@ agentkit config \
 # 3. 部署到运行时
 agentkit launch
 ```
-2. 调用智能体
+
+1. 调用智能体
 
 ```bash
 agentkit invoke '{"prompt": "用 Python 创建一个二分查找实现"}'
 ```
 
-## 📁 项目结构
-
-```
-ai_coding/
-├── agent.py              # 主智能体应用及配置
-├── tools.py              # 工具函数 (TOS 上传、URL 生成)
-├── requirements.txt      # Python 依赖
-└── README.md            # 项目文档
-```
-
-## 🔍 主要特性
-
-### 多语言支持
-支持 Python、Java、JavaScript、Go 等主流编程语言,具备自动语法验证。
-
-### 沙箱执行
-在隔离环境中运行代码,确保安全性并防止系统干扰。
-
-### 自动化部署
-前端代码自动上传到 TOS,生成预览 URL 以便立即测试。
-
-### 可观测性
-内置 OpenTelemetry 追踪和 APMPlus 监控,支持生产环境调试和性能分析。
-
 ## 常见问题
 
 **错误: `DATABASE_TOS_BUCKET not set`**
+
 - 需通过环境变量设置用于代码上传的 TOS 存储桶名称
 
-**代码执行超时**
+**代码执行超时：**
+
 - 检查沙箱服务状态和网络连接
 - 验证代码复杂度和执行时间要求
 
-**TOS 上传失败**
+**TOS 上传失败：**
+
 - 确认 Access Key/Secret Key 具有 TOS 写入权限
 - 验证存储桶名称和区域配置
 
+## 效果展示
+
+AI Coding 效果。
+
+## 常见问题
+
+无。
+
 ## 🔗 相关资源
 
 - [AgentKit 官方文档](https://www.volcengine.com/docs/86681/1844878?lang=zh)
 - [TOS 对象存储](https://www.volcengine.com/product/TOS)
 - [AgentKit 应用广场](https://console.volcengine.com/agentkit/region:agentkit+cn-beijing/application)
 - [AgentKit 控制台](https://console.volcengine.com/agentkit/region:agentkit+cn-beijing/overview?projectName=default)
+
+## 代码许可
+
+本工程遵循 Apache 2.0 License