Skip to content

docs: sync Feishu EN setup guide with CN and add websocket troubleshooting#10

Merged
hrygo merged 7 commits intohrygo:mainfrom
ChenGou-zheng:fix-issue-7
Mar 11, 2026
Merged

docs: sync Feishu EN setup guide with CN and add websocket troubleshooting#10
hrygo merged 7 commits intohrygo:mainfrom
ChenGou-zheng:fix-issue-7

Conversation

@ChenGou-zheng
Copy link
Contributor

@ChenGou-zheng ChenGou-zheng commented Mar 11, 2026

PR Type

  • 📖 docs (文档)
  • feat (新功能)
  • fix (缺陷修复)
  • refactor (重构)
  • test (测试)
  • chore (维护)

背景与问题

社区开发者在飞书长连接接入时常遇到"未检测到应用连接信息,请确保长连接建立成功后再保存配置"的报错,但现有 FEISHU_SETUP_BEGINNER.md 缺乏排障指南。同时,英文版本 FEISHU_SETUP_BEGINNER_en.md 与中文版的步骤和截图引用不同步,造成维护困难。

本 PR 补齐中文版报错排障小节并与英文版同步对齐。


变更范围

  • docs/FEISHU_SETUP_BEGINNER.md

    • 第 3 步后新增"常见报错排查:未检测到应用连接信息"小节
    • 包含 6 步排障流程 + 3 个常见根因
    • 明确指出凭证验证、应用发布/安装、网络代理三大要素
  • docs/FEISHU_SETUP_BEGINNER_en.md

    • 同步中文版步骤结构(合并 Verification/Encrypt Key 到 Step 3)
    • 新增英文版 troubleshooting 段落("Common Error Fix: No app connection detected")
    • 更新截图引用从 .svg 改为当前可用的 .png 资源
    • Step 编号重排(原 Step 5-7 改为 Step 5-6)
    • 进阶建议新增日志监控项
  • docs/REFERENCE.md & docs/REFERENCE_en.md

    • 飞书链接从占位符 # 改为 FEISHU_SETUP_BEGINNER.md / FEISHU_SETUP_BEGINNER_en.md
    • 状态文案从"开发中,敬请期待"改为"请参阅 飞书接入指南"

Issue Link

若有关联 Issue,请补全(示例):

  • Related to user feedback from Slack/Feishu communities
  • Resolves #XXX(如果有对应 GitHub Issue)

验证方式与结果

# 1. 检查中文版排障小节是否存在
grep -A 15 "未检测到应用连接信息" docs/FEISHU_SETUP_BEGINNER.md

# 2. 验证中英文步骤编号是否对齐
grep "^## 第 [0-9]\|^## Step [0-9]" docs/FEISHU_SETUP_BEGINNER*.md

# 3. 检查所有截图链接是否有效存在
for img in feishu_step{1,3,4}_{create_app,events,info}.png; do
  [ -f "docs/images/guides/$img" ] && echo "$img" || echo "$img missing"
done

# 4. 验证 REFERENCE 中飞书链接是否指向新文档
grep -n "FEISHU_SETUP_BEGINNER" docs/REFERENCE*.md

# 5. 验证"开发中"文案已被替换
! grep "开发中\|Development in progress" docs/REFERENCE*.md && echo "✅ Status text updated"

预期结果:所有检查通过,无断链,中英文同步。


兼容性与风险

  • 低风险:仅涉及文档更新,不影响任何代码逻辑
  • 向后兼容:新增的排障小节不影响现有用户流程
  • 无破坏性改动:截图文件名引用改为可用资源(.png),不丢失链接
  • ⚠️ 注意:新增排障步骤中涉及"网络代理"和"HTTP_PROXY"配置项,假设用户已在其他文档中了解这些概念(否则可补充链接)

回滚方案

# 方案 A:撤销本次提交
git revert <commit-hash>

# 方案 B:恢复到合并前状态
git checkout HEAD~1 -- docs/FEISHU_SETUP_BEGINNER*.md docs/REFERENCE*.md

# 方案 C:手动删除新增的 troubleshooting 小节
# 编辑 docs/FEISHU_SETUP_BEGINNER.md,删除"### 常见报错排查:未检测到应用连接信息"段落
# 编辑 docs/FEISHU_SETUP_BEGINNER_en.md,删除"### Common Error Fix: No app connection detected"段落

文档与用户可见变更

  • 是,已更新 docs/ 下多个文档
  • 否,仅内部改动

变更说明:

  • docs/FEISHU_SETUP_BEGINNER.md:新增排障指南,更符合"保姆级"标准
  • docs/FEISHU_SETUP_BEGINNER_en.md:与中文同步,提升多语言用户体验
  • docs/REFERENCE.md & docs/REFERENCE_en.md:飞书接入链接从占位符更新为真实路由

后续可考虑更新 CHANGELOG.md

## [Unreleased]
### Docs
- Added Feishu long-connection troubleshooting guide in `docs/FEISHU_SETUP_BEGINNER.md`
- Synchronized English Feishu setup guide with Chinese version
- Updated Feishu integration links in `docs/REFERENCE.md` and `docs/REFERENCE_en.md`

Checklist

  • 我已确认本 PR 有明确动机和业务价值

    • ✅ 社区反馈的实际痛点(长连接报错排障)
    • ✅ 提升中英文文档一致性和可维护性
  • 我已提供可复现的验证命令与结果

    • ✅ 五组 bash 命令可快速验证改动
  • 我已评估兼容性与风险

    • ✅ 低风险纯文档更新
  • 我已提供清晰的回滚方案

    • ✅ 三种回滚选项(自动、半自动、手动)
  • 若涉及用户可见变更,我已同步更新文档

    • ✅ 中英文皆已同步
  • 代码/文档已通过本地检查

    • ✅ Markdown 格式检查通过
    • ✅ 内部链接一致性验证通过
  • 若涉及多语言文档,我已确保中英文同步

    • ✅ 中英文步骤结构完全对齐、术语一致

额外说明

  1. 截图资产状态:当前引用的 .png 文件已存在,均为中文版实拍。英文版暂复用中文截图(UI 差异不大),后续可按需补新的英文标注版本。

  2. 术语一致性:中英文均保留以下专业术语不翻译:App ID、App Secret、Verification Token、Encrypt Key、WebSocket、Socket Mode。

  3. 后续迭代:建议开发者社区可在此基础上补齐其他平台(钉钉、企业微信等)的保姆级接入指南,遵循同一套模板和排障框架。

  4. 维护建议:飞书后台 UI 更新时,建议同步更新截图。可在 ISSUE 或 CONTRIBUTING.md 中明确截图更新的流程。

Copilot AI review requested due to automatic review settings March 11, 2026 11:46
Copy link
Contributor

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 updates the documentation to add/enable Feishu (Lark) onboarding materials and align the English references with the Chinese structure, including WebSocket “No app connection detected” troubleshooting.

Changes:

  • Replace placeholder Feishu links in CN/EN reference manuals with links to the new Feishu beginner guides.
  • Add new CN and EN Feishu (Lark) beginner setup guides (WebSocket/long-connection flow + troubleshooting + screenshot references).
  • Add log-monitoring recommendations and updated screenshot asset references.

Reviewed changes

Copilot reviewed 4 out of 7 changed files in this pull request and generated 6 comments.

File Description
docs/REFERENCE_en.md Links the Feishu section to the new EN Feishu beginner guide.
docs/REFERENCE.md Links the Feishu section to the new CN Feishu beginner guide.
docs/FEISHU_SETUP_BEGINNER_en.md New EN Feishu (Lark) WebSocket setup guide with troubleshooting and screenshot references.
docs/FEISHU_SETUP_BEGINNER.md New CN Feishu (Lark) WebSocket setup guide with troubleshooting and screenshot references.

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

ChenGou-zheng and others added 6 commits March 11, 2026 19:51
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

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

Copilot reviewed 4 out of 7 changed files in this pull request and generated 4 comments.


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

@hrygo hrygo merged commit 21b26d2 into hrygo:main Mar 11, 2026
5 of 6 checks passed
@hrygo
Copy link
Owner

hrygo commented Mar 11, 2026

感谢贡献!🫶

hrygo pushed a commit that referenced this pull request Mar 11, 2026
- Add Go variant documentation with comprehensive tool comparison
- Add quick selection guide for variant selection
- Merge Feishu integration guide (PR #10)
- Update 1+4 DRY architecture documentation
- Remove obsolete miniceM git remote

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

3 participants