SUMMARY - cso1z/Feishu-MCP GitHub Wiki

Wiki 文档结构总结

本文档列出了所有 Wiki 页面及其用途，方便快速查找。

📄 Wiki 页面列表

核心页面

  • Home.md - Wiki 主页，文档导航入口
  • _Sidebar.md - 侧边栏导航菜单
  • _Footer.md - 页脚信息

架构文档

  • 架构设计.md - 整体架构设计、技术栈、数据流转
  • 核心模块详解.md - 各模块功能、实现细节、代码示例
  • 认证与授权机制.md - Token 管理、多用户支持、安全机制

开发文档

  • 开发者指南.md - 环境搭建、开发流程、调试技巧
  • API-参考文档.md - 所有工具函数的详细文档
  • 最佳实践.md - 代码规范、性能优化、安全实践

使用文档

  • 飞书配置指南.md - 飞书应用配置详细步骤和权限设置

技术文档

  • MCP-协议实现.md - MCP 协议详解和传输层实现

工具文档

  • README.md - Wiki 文件使用说明
  • SUBMODULE_GUIDE.md - Git 子模块使用指南
  • GITHUB_WIKI_SETUP.md - GitHub Wiki 设置指南（历史参考）

🔗 链接关系

文档间的交叉引用

所有文档使用 [页面名](页面名) 格式相互链接：

  • 架构设计.md ↔ 核心模块详解.md ↔ 认证与授权机制.md ↔ 开发者指南.md
  • API-参考文档.md ↔ 最佳实践.md ↔ 开发者指南.md
  • MCP-协议实现.md ↔ 架构设计.md ↔ 核心模块详解.md
  • 飞书配置指南.md - 独立配置文档，通常从 Home.md 链接

外部链接

指向主仓库的链接使用完整 URL：

  • README: https://github.com/cso1z/Feishu-MCP#readme
  • FEISHU_CONFIG.md: https://github.com/cso1z/Feishu-MCP/blob/main/FEISHU_CONFIG.md

📝 编辑指南

  1. 直接编辑：在 doc/wiki-repo/ 目录下直接编辑文件
  2. 链接格式：使用 [页面名](页面名) 而不是 [文本](./文件.md)
  3. 文件名：不支持空格，使用连字符（如 API-参考文档.md）
  4. 提交：编辑完成后提交并推送到 GitHub Wiki

🔄 更新流程

# 1. 编辑文件
code doc/wiki-repo/架构设计.md

# 2. 提交更改
cd doc/wiki-repo
git add .
git commit -m "docs: 更新架构设计"
git push origin master

提示：所有文档都已配置好正确的链接关系，可以直接使用。