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

Aberta Para iniciantes
#406 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 4 dias

@IanoNjuguna já está trabalhando nisso.

Desde 22/11/2026.

  • #410 de @IanoNjuguna — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
62/100
Tipo de issue
Refatoração
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
docker, git, markdown, typescript
Domínio
documentation

Direção de pesquisa

A pasta com o nome escrito errado é website/docs/working-group/sessions/q4-2025/06-repo-walkthrough/sesion-notes/, com readme.md dentro dela. Verifique as entradas de redirecionamento que já existem em docusaurus.config.ts, depois renomeie o diretório com git mv e adicione um objeto de redirecionamento para a rota antiga. Está pronto quando session-notes/ substitui sesion-notes/, o build passa e a rota antiga aparece listada como redirecionamento. Coordene a atualização de #301 e #350 com a auditoria em andamento, já que a issue pede que o prazo seja informado no PR.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
TypeScript
Estrelas
13
Forks
24
Merge médio
2d 3h
PRs com merge (30d)
16

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de IntersectMBO/developer-experience

Todas as issues de IntersectMBO/developer-experience

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.