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

Aperta Adatta ai principianti
#406 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

@IanoNjuguna ci sta già lavorando.

Dal 22/11/2026.

  • #410 di @IanoNjuguna — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
62/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, git, markdown, typescript
Ambito
documentation

Direzione di ricerca

La cartella con il nome errato è website/docs/working-group/sessions/q4-2025/06-repo-walkthrough/sesion-notes/, con readme.md al suo interno. Controlla le voci di redirect già presenti in docusaurus.config.ts, quindi rinomina la directory con git mv e aggiungi un oggetto di redirect per la vecchia route. È completato quando session-notes/ sostituisce sesion-notes/, la build passa e la vecchia route compare tra i redirect. Coordina l'aggiornamento di #301 e #350 con l'audit in corso, poiché la issue chiede che la tempistica sia indicata nella PR.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
TypeScript
Stelle
13
Fork
24
Merge medio
2g 3h
PR unite (30g)
16

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di IntersectMBO/developer-experience

Tutte le issue di IntersectMBO/developer-experience

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.