Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#115 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
playwright, typescript
Área
accessibility, testing-qa

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
0
Forks
0
Merge medio
2 h 48 min
PR fusionados (30 d)
8

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de usabl-dev/usabl

Todos los issues de usabl-dev/usabl

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.