usabl docs: add a whole-app mode that documents every in-scope surface
まだ誰も着手していません。
評価
- 難易度
- 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分
- マージ済み PR（30日）
- 8
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
usabl-dev/usabl の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
chaitin/MonkeyCode#1437 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
carbon-design-system/carbon-ai-chat#2615 ·
メンテナーはふだん 1 日以内に返信
-
e2e-failure ready-to-code
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
redhat-developer/rhdh-plugin-export-overlays#4486 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: fileUploadMatrix.test.ts URL case does a real DNS lookup and fails offline対応中かも @r2jaff が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ComposioHQ/composio#5054 ·
メンテナーはふだん 1 日以内に返信