usabl docs: add a whole-app mode that documents every in-scope surface
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 52/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- playwright, typescript
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- TypeScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 2 小时 48 分钟
- 30 天内合并 PR
- 8
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
usabl-dev/usabl 的其他 Issue
-
area: engine bug
难度 2/5 1-3 小时 新手友好度 86/100
-
Stop hook allows a stop on an unknown verdict, and the self-check prints IDLE for a null verdict未关闭area: assistants bug
难度 2/5 1-3 小时 新手友好度 75/100
-
area: engine bug security
难度 2/5 1-3 小时 新手友好度 72/100
-
Overlay: browser context failures are counted per plugin, not per browser, and close is not shared未关闭area: overlay bug
难度 2/5 1-3 小时 新手友好度 64/100
-
area: engine enhancement performance
难度 2/5 1-3 小时 新手友好度 68/100
相似的 Issue
-
bug skills
难度 2/5 1-3 小时 新手友好度 77/100
equinor/fusion-framework#5846 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 74/100
-
难度 2/5 1-3 小时 新手友好度 85/100
Eyevinn/open-videocore#1256 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
[Bug]: Theme preset geist points at undefined --font-geist可能已有人在做 @claude 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 73/100
维护者通常 1 天内回复