Decide where a "documenting a slot" doc lives

Đang mở
#346 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/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ệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Read ADR 0009 and the slot versioning how-to in #344, then compare the README examples in CourseAuthoringUnitSidebarSlot and the site operators' slot reference. Decide where the convention should live and whether the reference should link to it; done means the location and scope questions in the issue are resolved and the documentation convention is recorded.

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

Mô tả

[!NOTE]
This issue was written by Claude (Claude Code) and reviewed before posting.

Goal: find a home for a document that says how a slot is documented: the README in the slot's folder, one README per slot version, what the previous version's README is named, and the deprecation note at its top.

Why: nothing says any of this today. Every slot in a frontend-base app has a README.md next to its component, and a slot with two versions has a README.v1.md beside it (frontend-app-authoring's CourseAuthoringUnitSidebarSlot has both, and the site operators' slot reference on docs.openedx.org links straight to the README.v1.md). That is a convention everyone follows and nobody wrote down.

#344 adds a how-to for versioning and renaming slots. Its examples show the README names (README.v1.md for a previous version; README.songList.v1.md for a renamed slot, the old README being named for the old slot minus what its id shares with the current one), but a how-to is the wrong place to state the rule, so the rule is shown by example and explained nowhere.

docs/ in this repo has two kinds of document: how_tos/ and decisions/. Neither fits. ADR 0009 is the slot naming and lifecycle record and says nothing about documentation; a file-naming convention is not a behaviour decision, so it does not belong in that ADR or in a new one. The sibling repos have the same two kinds (frontend-plugin-framework, frontend-platform and frontend-app-authoring have decisions/ and how_tos/; frontend-app-learning and paragon have decisions/ only), so there is no precedent in the ecosystem's frontend repos for a third kind.

Claude Plan

Open questions, in the order they would need answering:

  1. Where it lives: a new docs/references/ (or similar) in this repo; a developer-facing page on docs.openedx.org; or a section of an existing how-to such as the migration how-to's "Refactor slots".
  2. What it covers: the slot folder and its README.md; one README per slot version and per renamed slot, with the naming rule for the previous one; the deprecation note at the top of a previous README; the link from the current README to the previous one; whether an app's own slot index (such as src/plugin-slots/README.md) is part of the convention.
  3. Whether the site operators' slot reference on docs.openedx.org should point to it, so the README it links to is explained somewhere.

What this issue does not propose: changing ADR 0009, or what the #344 how-to shows.

Ngôn ngữ chính
TypeScript
Star
4
Fork
13
Merge trung bình
3 ngày 5 giờ
Pull request đã merge (30 ngày)
4

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 openedx/frontend-base

Tất cả issue của openedx/frontend-base

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.