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

usabl docs: alt-text manifest is dormant without content requirements

Aperta
  • Qualcosa non va?
#115 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
42/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
playwright, typescript
Ambito
accessibility, testing-qa

Direzione di ricerca

Start by reading the demo application's content requirements and the usabl docs --html generation path. Decide whether adding a small set of requirements gives a useful live example of the bound-without-evidence state, or whether documentation should explain why the alt-text manifest is absent. Done when the demo shows that state or its expected absence is clearly documented.

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

Descrizione

area: docs enhancement

Background

The alt-text manifest artifact is built from content requirements. When a project declares no content requirements, the manifest generator has nothing to draw from, so it emits no alt-text artifact.

Current behavior

On the demo application, which declares no content requirements, usabl docs produces only announcement-snippets and keyboard-paths. The alt-text-manifest kind never appears. As a result the "bound to a receipt but without per-entry evidence" honesty state, which the alt-text manifest is the canonical source of, is never exercised on the demo app. It is covered by unit tests, but not by any live run we can show.

Why this matters

The three honesty states the HTML renderer distinguishes are:

  1. verified: bound to a minted receipt and carries per-entry evidence.
  2. bound without evidence: bound to a receipt but no per-entry evidence, so the entries are expectations, not proof. The alt-text manifest is the real-world source of this state.
  3. observation: not bound to any receipt.

Without content requirements on a demo surface, state 2 has no live example, so a reader cannot see the middle state in a real generated page.

Proposed work

  • Decide whether the demo application should declare a small set of content requirements so the alt-text manifest, and therefore the middle honesty state, appears in a real run.
  • Alternatively, document clearly that the alt-text manifest is dormant until content requirements exist, so its absence is understood as expected, not as a missing feature.

Notes

Discovered while building and dogfooding usabl docs --html. No code defect: the generator behaves correctly given no content requirements. This is about coverage and demonstrability.

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.