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 摘要。