Rename the q4-2025 sesion-notes folder to session-notes, and keep its URL working

未关闭 适合新手
#406 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 4 天内回复

@IanoNjuguna 已经在做这个了。

开始于 2026年11月22日。

  • #410 来自 @IanoNjuguna —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
62/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
活跃
技术栈
docker, git, markdown, typescript
领域
documentation

调研方向

拼写错误的文件夹是 website/docs/working-group/sessions/q4-2025/06-repo-walkthrough/sesion-notes/,里面有 readme.md。先检查 docusaurus.config.ts 中已有的重定向条目,然后用 git mv 重命名该目录,并为旧路由添加一个重定向对象。完成标准是 session-notes/ 替换了 sesion-notes/,构建通过,且旧路由已列为重定向。由于 issue 要求在 PR 中说明时间安排,请将 #301 和 #350 的更新与正在进行的审计协调好。

由索引模型根据 Issue 内容生成。

描述

documentation Low Priority

Summary

One session folder is misspelled, and the misspelling is in the public URL:

website/docs/working-group/sessions/q4-2025/06-repo-walkthrough/sesion-notes/readme.md

Every other session in the tree uses session-notes: there are 22 of those and exactly one sesion-notes, and no other misspelled directory exists anywhere under website/docs.

What to change

  • Rename the directory to session-notes. Nothing inside it needs an edit: readme.md opens with an H1 rather than YAML frontmatter, and no file in the repository mentions the folder name.
  • Add a client redirect from the old route to the new one. @docusaurus/plugin-client-redirects is already wired in docusaurus.config.ts with two entries, so this is one more object in that array.
  • Update the two places that cite the old path: #301 (the verification table added today) and #350 (Page: field).

Challenges

1. The directory name is the URL. sesion-notes/readme.md has no frontmatter slug, so Docusaurus derives the id from the path and strips the 06- number prefix. The live route today, verified with curl against devex.intersectmbo.org:

200  /docs/working-group/sessions/q4-2025/repo-walkthrough/sesion-notes/
404  /docs/working-group/sessions/q4-2025/06-repo-walkthrough/sesion-notes/

So the rename is a public URL change, not a cosmetic tidy-up.

2. Without a redirect the old URL 404s. Anything already pointing at it breaks: bookmarks, external references, search-engine results, and past chat or issue links that are not in the repo. The plugin fixes it, but the entry is permanent: there is no expiry mechanism, so the config accumulates a redirect per rename and nobody removes it without deciding the old URL is dead.

3. CI will not catch the fallout. git grep sesion-notes across the tree returns nothing, so onBrokenLinks has no link to fail on: the build is green before and after. The stale references live in issues, not in the repo, which is why they need doing by hand in the same change.

4. The rename reads as a delete plus an add. Git only follows it with --follow, so a reviewer sees two files change when it is one move. Worth one sentence in the PR body rather than a review round trip.

5. It collides with the audit it is part of. #301 and #350 exist to verify that exact page. Renaming while the audit is open hands a verifier a path that moved under them. Land it before the audit reaches that page, or after it closes, and say which in the PR.

6. What is not affected. The parent _category_.json only carries the session label and position, sidebars.ts is autogenerated, the sibling recordings/ folder keeps its own route, and this page is not in src/data/sessions.json, so no generated index changes. The local-search index rebuilds at build time and will drop the old URL on its own.

Acceptance

  • 06-repo-walkthrough/ contains session-notes/ and no sesion-notes/
  • the old route 301s to the new one on the deployed site, and the new route 200s
  • #301 and #350 point at the new path
  • git log --follow on the moved readme.md still shows its history
  • the build stays green
主要语言
TypeScript
星标
13
派生
24
平均合并
2 天 3 小时
30 天内合并 PR
16

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

IntersectMBO/developer-experience 的其他 Issue

查看 IntersectMBO/developer-experience 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。