Decide where a "documenting a slot" doc lives
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
[!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.
- 主要言語
- TypeScript
- スター
- 4
- フォーク
- 13
- 平均マージ
- 3日 5時間
- マージ済み PR(30日)
- 4
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openedx/frontend-base のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
openedx/frontend-base#330 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
openedx/frontend-base#327 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
openedx/frontend-base#210 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
openedx/frontend-base#350 ·
-
External routes ignore params対応中かも @arbrandes が今日担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
openedx/frontend-base#349 · 担当者 1 名 ·
openedx/frontend-base の issue をすべて見る
似ている issue
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openclaw/openclaw#200365 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
effort: small good first issue priority: medium testing
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
TMHSDigital/screencast-mcp#351 ·
メンテナーはふだん 1 日以内に返信
-
area-templates triage:bot-seen triage:needs-human
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
microsoft/aspire#22356 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Archiving an agent that is not loaded keeps its old updatedAt対応中かも @luoph が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
content triage
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信