Decide where a "documenting a slot" doc lives
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
[!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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 4
- Forks
- 13
- Merge medio
- 3 d 5 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openedx/frontend-base
-
Export `SkipLink` componentAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
openedx/frontend-base#330 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
openedx/frontend-base#327 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
openedx/frontend-base#210 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
openedx/frontend-base#350 ·
-
External routes ignore paramsPosiblemente ocupada @arbrandes la tomó hoy. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
openedx/frontend-base#349 · 1 asignado ·
Todos los issues de openedx/frontend-base
Issues similares
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
openclaw/openclaw#200365 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
effort: small good first issue priority: medium testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
TMHSDigital/screencast-mcp#351 ·
Los mantenedores suelen responder en 1 día
-
area-templates triage:bot-seen triage:needs-human
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
microsoft/aspire#22356 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Archiving an agent that is not loaded keeps its old updatedAtPosiblemente ocupada @luoph la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
content triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día