Skip to content

docs(lark): drop dead link to uncommitted sandbox init spec - #4705

Merged
WillemJiang merged 1 commit into
bytedance:mainfrom
icn5381:docs/fix-lark-cli-init-dead-link
Aug 8, 2026
Merged

docs(lark): drop dead link to uncommitted sandbox init spec#4705
WillemJiang merged 1 commit into
bytedance:mainfrom
icn5381:docs/fix-lark-cli-init-dead-link

Conversation

@icn5381

@icn5381 icn5381 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Fixes #

Why

I'm getting started with DeerFlow — reading through the codebase to learn
how it fits together and looking for a small, concrete way to contribute.
While exploring, I got curious about the state of the docs and checked the
internal links across the .md files. That surfaced a dead one:
docker/lark-cli-init/README.md points to
docs/superpowers/specs/2026-07-21-lark-sandbox-init-container-design.md, a
design spec that was never committed (absent across the full git history —
dead on arrival in #3971). For the next person digging into the lark sandbox
init design, that's a 404 dead end. It's a tiny fix, but it felt like a good
first contribution: self-contained, and it leaves the docs a little better
than I found them.

What changed

Removed the dangling "See the design at ..." reference from the
lark-cli-init README. The README's body (What it does / Build / Wiring it
into the provisioner) already documents the init-container behavior on its
own, so no information is lost.

Surface area

  • Docs / tests / CI only — no runtime behavior change

Validation

Docs-only change to docker/lark-cli-init/README.md. No backend Python or
frontend js/ts touched, so the ruff / eslint / prettier hooks do not
apply. Verified the target spec path is absent across the full git history
(git log --all -- <path> → empty) and absent in the working tree.

AI assistance

Tool(s) used: Claude Code

How you used it: AI 辅助 Coding — 用脚本扫描仓库 .md 文档的坏相对链接,定位到这一处并生成删除改动;改动由人类逐行审阅定稿。

人类验证环节:

  • 逐行确认改动内容(仅删除指向不存在文件的链接句,共 3 行)

  • 核实目标 spec 在 git log --all 全历史中从未存在、工作树中也不存在

  • 确认该坏链接由 feat: add Lark CLI integration #3971 引入、已断开约 11 天

  • 确认 README 主体自包含,删除该引用不丢失实质信息

  • 对本次提交负全部责任

  • I've read and understand every line of this change and take responsibility for it — it's not unreviewed AI output.

The docker/lark-cli-init/README.md referenced
docs/superpowers/specs/2026-07-21-lark-sandbox-init-container-design.md,
but that design spec was never committed to the repository — it is absent
across the full git history. The link has been broken since it was
introduced in bytedance#3971. The README already documents the init-container
behavior standalone, so the dangling reference is removed.
@CLAassistant

CLAassistant commented Aug 6, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added area:docs Documentation and Markdown only area:sandbox Sandboxed execution and docker/ risk:low Low risk: docs / i18n / assets only size/XS PR changes < 20 lines labels Aug 6, 2026
@WillemJiang
WillemJiang merged commit 295d7c2 into bytedance:main Aug 8, 2026
9 checks passed
yangjl pushed a commit to yangjl/deer-greenagent that referenced this pull request Aug 8, 2026
…e#4705)

The docker/lark-cli-init/README.md referenced
docs/superpowers/specs/2026-07-21-lark-sandbox-init-container-design.md,
but that design spec was never committed to the repository — it is absent
across the full git history. The link has been broken since it was
introduced in bytedance#3971. The README already documents the init-container
behavior standalone, so the dangling reference is removed.

Co-authored-by: icn5381 <255778606+icn5381@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and Markdown only area:sandbox Sandboxed execution and docker/ risk:low Low risk: docs / i18n / assets only size/XS PR changes < 20 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants