a11y: add skip-to-content link, ARIA tree roles for sidebar, and alt text for diagrams
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 50/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- typescript
調査の方向性
まず、issue で言及されている 2 つのテーマレイアウト、サイドバーナビゲーション、検索結果タイプのアイコン、Mermaid コードブロックのレンダリングを特定します。それぞれが現在、フォーカス、展開可能な項目、アイコンのラベル、注入された SVG をどのように扱っているかを確認します。キーボードユーザーがナビゲーションをスキップでき、スクリーンリーダーが両方のテーマで指定された role、ラベル、図の説明を受け取れるようになれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
Problem
Several accessibility gaps across both themes:
- No skip-to-content link — keyboard users must tab through the entire sidebar/nav to reach content
- Sidebar lacks ARIA tree roles — collapsible sidebar items don't use `role="tree"`, `role="treeitem"`, or `aria-expanded`. Screen readers can't navigate the doc structure.
- Search result icons have no aria-labels — the document/hashtag/code icons are decorative but convey meaning (page vs heading vs API result)
- Mermaid diagrams have no alt text — SVG is injected via `dangerouslySetInnerHTML` without `aria-label` or `<title>` element
Suggested Fixes
- Add a visually-hidden skip link as the first focusable element in both theme layouts
- Add `role="tree"` to sidebar ``, `role="treeitem"` + `aria-expanded` to collapsible folders
- Add `aria-label` to search result type icons
- Allow a `alt` or `caption` prop on mermaid code blocks, inject as SVG `<title>`
- 主要言語
- TypeScript
- スター
- 2
- フォーク
- 1
- 平均マージ
- 12分
- マージ済み PR(30日)
- 1
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
raystack/chronicle のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 65/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
raystack/chronicle の issue をすべて見る
似ている issue
-
area: desktop area: website priority: P2 type: feature
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
appandflow/stim#3411 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
rjsf-team/react-jsonschema-form#5485 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
lingdojo/kana-dojo#32090 · コメント 1 件 · リアクション 5 件 ·
メンテナーはふだん 1 日以内に返信
-
Friction: Org home and org switcher copy still say repositories and connected agents live in the personal account対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンfriction
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
kentcdodds/kody#3265 ·
メンテナーはふだん 1 日以内に返信