Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

a11y: add skip-to-content link, ARIA tree roles for sidebar, and alt text for diagrams

オープン
#140 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
50/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
typescript

調査の方向性

まず、issue で言及されている 2 つのテーマレイアウト、サイドバーナビゲーション、検索結果タイプのアイコン、Mermaid コードブロックのレンダリングを特定します。それぞれが現在、フォーカス、展開可能な項目、アイコンのラベル、注入された SVG をどのように扱っているかを確認します。キーボードユーザーがナビゲーションをスキップでき、スクリーンリーダーが両方のテーマで指定された role、ラベル、図の説明を受け取れるようになれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

Problem

Several accessibility gaps across both themes:

  1. No skip-to-content link — keyboard users must tab through the entire sidebar/nav to reach content
  2. 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.
  3. Search result icons have no aria-labels — the document/hashtag/code icons are decorative but convey meaning (page vs heading vs API result)
  4. 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 ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

raystack/chronicle のほかの issue

raystack/chronicle の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。