Skip to content

docs(arkitect): fix broken links in the root and arkitect READMEs - #263

Open
Jinzhengxu wants to merge 2 commits into
volcengine:mainfrom
Jinzhengxu:docs/fix-readme-links
Open

Jinzhengxu wants to merge 2 commits into
volcengine:mainfrom
Jinzhengxu:docs/fix-readme-links

Conversation

@Jinzhengxu

Copy link
Copy Markdown

改了什么

  • arkitect/README_en.md:应用表格里三个 demohouse README 链接和 License 段的两个许可证链接原本指向 https://chatgpt.com/c/...(翻译时残留的假链接),改为中文 README 已在使用的相对路径 ../demohouse/<app>/README.md、../APACHE_LICENSE、../ARK_LICENSE.md;顺手修正同一表格里的 udnerstanding 拼写。
  • arkitect/README.md:./APACHE_LICENSE(两处)和 ARK_LICENSE.md 会解析到 arkitect/ 目录下,但两个文件都在仓库根目录,改为 ../APACHE_LICENSE、../ARK_LICENSE.md。
  • README.md 与 arkitect/README.md:「深度推理」条目仍指向 demohouse/deep_research/README.md,该目录已改名为 demohouse/deep_search,改为新路径。

共 3 个文件、10 处链接,+10 −10,只改 Markdown,不涉及代码。

为什么

这些链接在 GitHub 上目前要么 404,要么跳转到 chatgpt.com,其中还包括两个 README 的许可证链接。

怎么检查的

  • 对三个 README 的全部相对链接做存在性检查:改前 10 处失效,改后 0 处;grep -rn "chatgpt\.com\|deep_research/" README.md arkitect/ 无命中。
  • 两个提交分别使用 docs(demohouse/deep_search) 和 docs(arkitect) scope,符合 commitlint.config.ts 的 validate-scope 规则。

…ctory

README.md and arkitect/README.md still link ./demohouse/deep_research/README.md,
but the demo lives in demohouse/deep_search (deep_research no longer exists).
- README_en.md linked the three demohouse READMEs and both license files
  through https://chatgpt.com/c/... URLs; use the relative paths the Chinese
  README already uses.
- README.md linked ./APACHE_LICENSE and ARK_LICENSE.md, which resolve inside
  arkitect/ where neither file exists; both live at the repository root.
- Fix the 'udnerstanding' typo in the video-analyser row.
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