registrystack / registrystack/registry-stack

Take reference/breg-api and reference/breg-configuration out of draft

Aperta
#940 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
agent-ready area:breg area:docs criticality:p3 documentation triage:needs-implementation
Lingua principale
Rust
Stelle
2
Fork
0
Merge medio
2h 55m
PR unite (30g)
130

Descrizione

Found in the 0.28.0 pre-release review (2026-09-08). Line references are as of main after #926.

Both pages are `status: draft`, `last_reviewed: unreviewed`, with 12 and 7 inbound links from current pages. `breg-configuration.mdx` is generated from schema descriptions; most properties added since v0.27.0 carry no `description` on their schemars types and render as blank rows, and `actions[].requires[].equals` never renders because its subschema is the bare boolean `true` (`registry-project.schema.json:502`), which `docs/site/scripts/configuration-reference.mjs:306` drops.

Proposed: add `description` to the schemars types, teach the walker to render boolean subschemas, then review both pages and set their review record.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo docs/site/scripts/configuration-reference.mjs intorno alla riga 306 e ispezionando registry-project.schema.json:502, quindi segui i tipi schemars che forniscono le descrizioni della configurazione. Il lavoro è completo quando le properties vuote e actions[].requires[].equals vengono renderizzate correttamente, sono stati esaminati sia reference/breg-api sia reference/breg-configuration e i relativi record di revisione non risultano più come unreviewed.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, rust
Ambito
backend-api-design, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Attiva
Chiarezza
Specificata chiaramente
Idoneità per principianti
62/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.