Decide where a "documenting a slot" doc lives
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:
- 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". - 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 assrc/plugin-slots/README.md) is part of the convention. - 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
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của openedx/frontend-base
-
Export `SkipLink` componentĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
openedx/frontend-base#330 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
openedx/frontend-base#327 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
openedx/frontend-base#210 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
openedx/frontend-base#350 ·
-
External routes ignore paramsCó thể đã có người làm @arbrandes đã nhận hôm nay. Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
openedx/frontend-base#349 · 1 người được giao ·
Tất cả issue của openedx/frontend-base
Issue tương tự
-
bug P3
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 87/100
Maintainer thường phản hồi trong vòng 1 ngày
-
feat(ai): add markdown checklist export and copy-to-clipboard button to ActionItemSynthesizer drawerĐang mởai enhancement feature feature-request good-issue L1 level 1 needs-review wocs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
SatyamPandey-07/WorkSphere#8149 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement follow-up
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 67/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Client execution contract accepts a grant the code never takesCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mởarea: client enhancement priority: medium
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
opensro-dev/opensro#3808 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug ux
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
mithilp/keybuddies#66 ·