Skip to content

docs: 统一目标入口与学习路线选择 - #165

Open
yiweinanzi wants to merge 1 commit into
mainfrom
codex/unify-doc-entry
Open

docs: 统一目标入口与学习路线选择#165
yiweinanzi wants to merge 1 commit into
mainfrom
codex/unify-doc-entry

Conversation

@yiweinanzi

@yiweinanzi yiweinanzi commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

首次访问仓库时,首页把开发岗、算法岗和科研专题并列,新手入口又分别指向简版路线、六步求职流程等材料,读者难以判断从哪里开始、哪些资料必须读。本 PR 将首页入口统一为系统学习、做项目、准备面试、科研探索;系统学习先判断基础,再选择开发岗或算法岗主线。

四条阅读路径的前后对照

目标 修改前 修改后
系统学习 首页直接进入开发岗/算法岗正文;部分新手提示指向简版路线或六步求职流程 首页 → 学习路线选择器 → 新手导航或开发岗/算法岗主线;新手按“学习地图 → 七日计划”开始,完成后返回选择器
做项目 首页本页实战章节、快速导航中的项目入口并存 首页“做项目” → 现有项目导航 → 对应项目蓝图
准备面试 首页目录主要跳到本页第六步,再查找题库与专项 首页“准备面试” → 现有面试与求职导航 → 岗位题库与专项
科研探索 首页以“科研前沿专题”与两类岗位路线并列 首页“科研探索” → 现有科研前沿入口 → 研究子方向

四个目标采用相同层级,均可从首页一次点击进入对应导航。其下的“按技术主题查找”统一进入文档总导航,主题索引用于回查具体内容,不另设学习主线。

修改范围

仅修改四个文档入口:

  • README.md:前置四类目标,合并重复入口,统一新手与学习路线链接,说明六步路径和八阶段 Todo 的求职准备、产出检查用途。
  • docs/README.md:沿用相同目标名称,区分目标导航与主题查找,将路线选择集中到路线导航。
  • docs/00-getting-started/README.md:明确“学习地图 → 七日计划”、基本编程与 API 前置知识,并补上入门后的主线分流。
  • docs/05-roadmaps/README.md:先区分基础,再选开发岗/算法岗两条主线;将其余四份路线标为总览、求职产出检查、前沿算法扩展、VLA 扩展,并说明下一步入口。

从最新 main24082336)建立独立分支,未带入上一轮试做改动。现有长文、文件位置、元数据、引用来源与自动生成索引保留,网站不在本次修改范围内。

验证

  • python scripts/manage_content_catalog.py --check:通过,20 个公开索引、137 篇文档、16 条 Backlog。
  • python tests/markdown_links.test.py:通过,192 个源文件。
  • python tests/repository_automation.test.py:通过。
  • git diff --check:通过。
  • 额外使用 GitHub Markdown 渲染结果和 github-slugger 比对修改前后标题及锚点:四页原有 110 个标题和对应锚点全部保留,四页 19 处本地片段链接逐项通过。
  • 重点确认 README 的快速开始、岗位学习路线、社群锚点,以及文档导航的 #项目与资源 仍可用。
  • 比对四页的元数据、自动生成区域与外部来源链接,均保留;检查改动清单,仅包含上述四个文件。
  • 逐条验证首页四条阅读路径、七日计划入口、新手返回选择器后进入两条主线的路径,以及六份路线的手写导航链接。经路线选择器进入学习地图正文共 3 次点击;首页新手快捷入口共 2 次点击。

本 PR 的 CI 已全部通过:Content and repository checks、Research site build、InterviewGuide test and build、Assemble and smoke-test Pages。当前等待正常 PR 评审与合并。

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