Skip to content

Add documentation for AI agents and introduce agent-assisted PR support.#17

Open
Chi-Shan0707 wants to merge 4 commits intovictkk:masterfrom
Chi-Shan0707:feat/agent
Open

Add documentation for AI agents and introduce agent-assisted PR support.#17
Chi-Shan0707 wants to merge 4 commits intovictkk:masterfrom
Chi-Shan0707:feat/agent

Conversation

@Chi-Shan0707
Copy link
Contributor

feat: add AGENT_GUIDE for working with agents;
fix: two typos, one in README.md and one in CONTRIBUTING.md
docs: acknowledgement add myself()

Copilot AI review requested due to automatic review settings March 21, 2026 06:23
@vercel
Copy link

vercel bot commented Mar 21, 2026

@Chi-Shan0707 is attempting to deploy a commit to the david1770173's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves contributor documentation by adding an AI-agent workflow guide and updating existing docs (including acknowledgements) to better support agent-assisted and manual contributions.

Changes:

  • Add Agent/AGENT_GUIDE.md and Agent/README.md documenting an AI-agent assisted contribution flow.
  • Update README.md to fix a formatting issue and add an “AI Agent 辅助贡献” section linking to the new guide.
  • Fix a typo in .github/CONTRIBUTING.md and add an acknowledgement entry in pages/index.mdx.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Fixes command formatting and introduces an AI-agent contribution entrypoint linking to the agent guide.
pages/index.mdx Adds a new contributor acknowledgement entry.
Agent/README.md Documents what the Agent/ directory contains and how to use it with an AI agent.
Agent/AGENT_GUIDE.md Adds a detailed end-to-end agent operating guide for adding course resources and updating navigation/pages.
.github/CONTRIBUTING.md Corrects the course registry file reference from _meta.json to _meta.ts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 63 to 66
4. 提交 **Pull Request**

详细步骤请查看 [使用与贡献指南](/pages/guide.mdx)

Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

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

[使用与贡献指南](/pages/guide.mdx) 这种以 / 开头的链接在 GitHub README 中会被解析为站点根路径,通常会跳到 github.com/pages/guide.mdx 而不是仓库文件;建议改成相对仓库路径(如 ./pages/guide.mdx / pages/guide.mdx),或如果想指向站点路由则用 /guide

Copilot uses AI. Check for mistakes.
- 小马土豆
- 寻安
- chiyuhan
-
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

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

鸣谢列表末尾的 - 是一个空的列表项,渲染时会出现空 bullet,且可能影响后面 --- 分隔线的解析;建议删除该空行并在列表与 --- 之间保留一个空行即可。

Suggested change
-

Copilot uses AI. Check for mistakes.
Comment on lines +9 to +16
## 🚀 启动步骤(Agent 必读)

**收到用户请求后,必须首先执行:**

```
第1步: Read pages/courses/_meta.ts
```

Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

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

该指南里使用了特定 Agent 平台的“Read / Edit / Write / Bash / AskUserQuestion”等工具名与强约束(例如“必须使用 Bash 工具执行 mv”)。如果目标读者包含 Claude Code、Copilot Workspace 等不同平台,建议在文档中明确这些是“概念步骤/示例”,并给出更通用的表述(如“在终端执行 mv”“如需确认则直接向用户提问”),避免读者误以为必须具备同名工具。

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@Chi-Shan0707 Chi-Shan0707 left a comment

Choose a reason for hiding this comment

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

I forget add instructions for agent-assited PR in CONTRIBUTING.md

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.

2 participants