Skip to content

[docs] 文档与实现不一致问题修复 #15

@aaronwong1989

Description

@aaronwong1989

问题描述

项目文档与技术实现存在多处不一致,需要修复以提升用户体验。

问题清单

  1. README.md 提到钉钉配置,但实际不存在

    • README.md 技术文档表格中提到 "飞书/钉钉配置"
    • 但项目中只有 FEISHU_SETUP_BEGINNER.md,没有对应的钉钉配置文档
  2. README.md 中 make up 指令说明不完整

    • 常用指令表格只写 make up 启动服务
    • 但实际启动后需要运行 make onboard 才能完整配置
  3. FEISHU_SETUP_BEGINNER.md 与 .env.example 不一致

    • 文档说明 .env.example 不包含 FEISHU_* 变量
    • 但用户可能期望通过 .env 配置飞书
  4. 环境变量文档与实际 .env.example 差异

    • 文档提到 Slack 管理员、频道白名单等配置
    • 但部分变量命名或说明与实际实现有出入

修复方案

  1. 将 README.md 技术文档表格中的"钉钉"移除(因为没有对应文档)
  2. 完善 make up 指令说明
  3. 更新 FEISHU_SETUP_BEGINNER.md 的说明
  4. 同步 .env.example 与文档的变量说明

优先级: P2
类型: docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions