Normalise session archive routes: mixed slug and folder-path URLs, duplicate session 14

Đang mở
  • Có gì không ổn?
#375 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reading the session notes frontmatter under website/docs/working-group/sessions/ and scripts/generate-sessions.js to see how slugs feed the carousel. Check the Docusaurus redirect configuration and CONTRIBUTING.md for existing conventions. Confirm the intended quarter and numbering for the conflicting sessions with maintainers, then update routes and redirects; done means all sessions use the stated URL shape, generated links pass the build's broken-link check, and the convention is documented.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation Low Priority
Page or section

website/docs/working-group/sessions/** (the working group session archive) and anything that links into it.

Issue description

The session archive serves two different URL shapes depending on whether a notes page carries a slug in frontmatter, and two folders claim the same session number.

Of the 21 sessions in the archive, 13 have a slug and are served at:

/docs/working-group/<quarter>/sessions/<NN-slug>/session-notes/

The other 8 have no slug, so Docusaurus falls back to the folder path, which strips the numeric prefix and keeps the literal sessions segment:

/docs/working-group/sessions/<quarter>/<slug>/session-notes/

The 8 without a slug:

Quarter Folder
q1-2026 09-community-builder-story
q1-2026 10-wallet-integration
q1-2026 11-open-source-docs
q1-2026 12-cardano-developer-pathway
q4-2025 01-kickoff-orientation
q4-2025 02-dev-opportunities
q4-2025 03-dev-environment-setup
q4-2025 04-essential-links

Three more inconsistencies in the same tree:

  1. Number 14 is used twice. q1-2026/14-CIP-68 NFT-Standard and q2-2026/14-sdk-repo-walkthrough both claim session 14, and both are live pages.
  2. Two slugs point at the wrong quarter. q1-2026/07-contributing-intersect and q1-2026/08-open-clinic-1 have slugs under /working-group/q1-2025/..., so their URLs say Q1 2025 while their folders say Q1 2026.
  3. Folder names break their own convention. 14-CIP-68 NFT-Standard is capitalised and contains a space, Session-1 / Session-2 / Recording are capitalised, and the quarter directory named q1-2026 holds documents whose URLs say q1-2025.

Impact: any tool that derives archive links from the filesystem has to replicate Docusaurus's slug and number-prefix rules exactly. The scripts/generate-sessions.js generator that feeds the new session carousel on the landing page does exactly that, and its first version got one of the 8 fallbacks wrong; the build's broken-link check is the only thing that caught it, because a wrong route in the generated JSON fails the build rather than 404ing silently in production. Search results, cross-links between sessions, and any future redirect map inherit the same problem.

Nothing is broken for a reader today. Every existing route resolves.

Proposed change

Normalise the archive so a session's URL is a function of its quarter and number, and so a tool never has to guess:

  • Add slug: /working-group/<quarter>/sessions/<NN-slug>/session-notes to the 8 notes pages that lack one, so every session has a slug in the same shape.
  • Renumber one of the two 14s. The CIP-68 session predates the SDK walkthrough, so it likely needs a new number or a move into the quarter it actually belongs to.
  • Fix the 07 and 08 slugs to q1-2026, or move those folders into a q1-2025 directory, whichever matches when the sessions actually ran.
  • Rename 14-CIP-68 NFT-Standard to 14-cip-68-nft-standard, and lowercase Session-1, Session-2 and Recording for consistency with the rest of the tree.
  • Add the old URLs to @docusaurus/plugin-client-redirects so inbound links and search results do not break when routes move.
  • Note the convention in CONTRIBUTING.md so new sessions land in the right shape.

Once every session carries a slug, scripts/generate-sessions.js can drop its path-derivation fallback and simply read the slug, which removes the class of bug entirely.

Checks
  • I searched existing issues and discussions
  • This is about documentation (not a feature request or bug)
Ngôn ngữ chính
TypeScript
Star
13
Fork
24
Merge trung bình
3 ngày 1 giờ
Pull request đã merge (30 ngày)
34

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của IntersectMBO/developer-experience

Tất cả issue của IntersectMBO/developer-experience

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.