Skip to content

docs: add FAQ section for common questions#698

Open
meichuanyi wants to merge 1 commit intonrslib:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: add FAQ section for common questions#698
meichuanyi wants to merge 1 commit intonrslib:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

变更说明

  • 添加 FAQ 章节,覆盖平台概念/安装配置/支持的 Agent/工作流/工具集成/故障排查
  • FAQ 放置在 Documentation 章节之前,保持文档结构清晰

FAQ 内容覆盖

  • 通用问题:平台概念、与 LangChain/CrewAI 区别、支持的 AI 提供商
  • 安装与配置:npm 安装、前置条件、配置文件位置
  • 使用指南:交互模式、工作树隔离、GitHub Issue 集成
  • 工作流与自定义:YAML 工作流、Faceted Prompting
  • 故障排查:任务失败重试、执行日志、OAuth/API Key 问题

检查清单

  • 文档符合项目规范
  • FAQ 内容基于项目 README 和文档定制
  • 放置在合适的位置(Documentation 章节之前)

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.

1 participant