Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
#115 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
playwright, typescript

Research direction

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.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
2h 48m
Merged PRs (30d)
8

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from usabl-dev/usabl

All issues in usabl-dev/usabl

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.