Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

usabl docs: add a whole-app mode that documents every in-scope surface

Aperta
  • Qualcosa non va?
#114 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
playwright, typescript
Ambito
accessibility, developer-experience

Direzione di ricerca

Start by reading the usabl docs command path and tracing how it selects in-scope surfaces from a run and git status. The issue identifies the renderer’s three honesty states as already working, so focus on what the generator feeds it. Done means a whole-app mode includes every in-scope surface independent of git status while preserving honest empty results, receipt evidence requirements, and exit 0 without minting a verdict.

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

Descrizione

area: docs enhancement

Background

usabl docs projects documentation artifacts (alt-text manifest, announcement snippets, keyboard paths) from a run. Today the run it projects from is scoped the same way the gate scopes work: to the surfaces the current change actually touched. That is the right default for the gate, because the gate only judges what changed. It is a surprising default for documentation, where a reader usually wants the whole application described, not just the diff.

Current behavior

On a clean working tree, a run reaches few or no surfaces, so usabl docs (and usabl docs --html) can produce little or nothing. That is honest, but it is easy to mistake for a bug: "I asked for the docs and got an almost empty page."

Proposed behavior

Add a whole-app documentation mode that documents every in-scope surface, independent of git status, so a reader can generate a full accessibility document for the application on demand.

Keep the honesty invariant intact:

  • A clean tree with nothing to prove should still yield an honest idle or empty result, clearly labelled, never a fabricated verdict.
  • Whole-app mode is a generator like the current command: it always exits 0 and mints no verdict. Only surfaces that reached a minted receipt with per-entry evidence may read as verified; everything else stays an expectation or an observation, exactly as in the per-change mode.

Notes

Discovered while building usabl docs --html. The renderer already distinguishes the three honesty states correctly; this issue is about widening what the generator feeds it, not about the rendering.

Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
2h 48m
PR unite (30g)
8

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di usabl-dev/usabl

Tutte le issue di usabl-dev/usabl

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.