Skip to content

Commit 43f97b9

Browse files
committed
Add Description heading below each diagram image
1 parent 1ef152f commit 43f97b9

7 files changed

Lines changed: 14 additions & 0 deletions

docs/01-understanding-github-web-structure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ Your personal home (`github.com`) shows activity from repositories you follow. Y
196196

197197
![](images/repo-page-layout-01.svg)
198198

199+
### Description
200+
199201
A repository home page is laid out from top to bottom as follows. The Global Navigation bar (landmark: "Navigation Menu") contains the GitHub logo, Search, Copilot, Pull Requests, Issues, Notifications bell, and your avatar. Below that are the Repository Tabs (landmark: "Repository navigation") showing Code, Issues (12), Pull requests (3), Actions, and more. Next is the Repository Header, which is the H1 heading "owner / repo-name" plus Star (42), Watch, and Fork (8) buttons. The main content area is split into two columns. On the left is the File Area with the branch selector (main), Go to file button, Code button, and the File Table (a landmark) listing files like .github/, docs/, and README.md with dates. On the right is the Sidebar with the About section, description text, topics (accessibility), Releases (3), Contributors (5), and Languages (Markdown 100%). Below both columns is the rendered README (landmark: "Repository files navigation"), and at the bottom is the Footer.
200202

201203
### Screen reader navigation of this page

docs/02-navigating-repositories.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ When you navigate to a GitHub repository (e.g., `https://github.com/owner/repo-n
3131

3232
![](images/repo-page-layout-02.svg)
3333

34+
### Description
35+
3436
The repository home page is organized from top to bottom as follows. The Navigation bar (GitHub global nav) contains the avatar menu, Notifications, and search. Below that is the Repository header showing "owner / repo-name" as the H1 heading, plus Star, Watch, and Fork buttons. Next are the Repository navigation tabs (a landmark) with Code (active), Issues, Pull requests, Actions, and more. The main content area is split into two columns: on the left is the File tree / code panel with the branch selector, Files table (navigable as a table), and last commit message; on the right is the Sidebar with the About section, topics, and releases. Below both columns is the rendered README.md in a separate landmark region.
3537

3638

docs/03-the-learning-room.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Before starting Chapter 4 challenges, students should be able to:
2525

2626
![](images/learning-room-tree.svg)
2727

28+
#### Description
29+
2830
The learning-room is a single shared repository. It has a protected main branch, and each student opens pull requests against it. For example: Student A's PR #12 is open and assigned to Student B for review, Student B's PR #13 is assigned to Student C, Student C's PR #14 is assigned to Student A, and Student A's earlier PR #11 has already been merged. More PRs appear as students contribute.
2931

3032
### Why one shared repo?

docs/12-github-pull-requests-extension.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,8 @@ gh pr list --search "review-requested:@me"
192192

193193
![](images/pr-tree.svg)
194194

195+
#### Description
196+
195197
The GitHub Pull Requests panel has two top-level sections. "My Pull Requests" contains four filters: Assigned to Me, Created by Me, Waiting for my Review, and All Open. The repository section shows Local Pull Request Branches (checked out locally), All Open Pull Requests, and All Closed Pull Requests.
196198

197199
#### Screen reader announcement example

docs/15-issue-templates.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,8 @@ Templates live in a specific folder in your repository:
195195

196196
![](images/template-folder-tree.svg)
197197

198+
### Description
199+
198200
Templates live inside your-repo/.github/. The ISSUE_TEMPLATE/ subfolder contains: bug_report.md (Markdown template), feature_request.md (Markdown template), accessibility-bug.yml (YAML form template), and config.yml (template chooser configuration). The pull_request_template.md file sits directly in .github/, not inside ISSUE_TEMPLATE/.
199201

200202
**Markdown templates (`.md`):** Traditional template format. Pre-fills a text editor with structured Markdown content. Contributors edit the template directly, replacing instructions and placeholder text with their own content.

docs/appendix-m-vscode-accessibility-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ The Accessible Diff Viewer presents file diffs as a structured, line-by-line lis
177177

178178
![](images/diff-viewer-tree.svg)
179179

180+
##### Description
181+
180182
The Accessible Diff Viewer starts with a header showing the file path and change summary. It then shows each hunk (changed section) in order. Each hunk contains: the hunk location (line range), unchanged context lines, the modified, added, or removed lines with their prefix, and more context lines. After all hunks, a footer shows the totals for additions and deletions.
181183

182184
#### Line prefixes

docs/appendix-q-github-actions-workflows.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ Workflow files live in a specific, mandatory location:
5757

5858
![](images/workflow-folder-tree.svg)
5959

60+
### Description
61+
6062
Workflow files live at your-repository/.github/workflows/. Example files include: ci.yml (runs tests on every push or PR), lint.yml (checks code style), a11y-scan.yml (accessibility scanning), and deploy.yml (deploys the site when code merges to main).
6163

6264
The `.github/` folder is hidden by convention (starts with a dot). To find it:

0 commit comments

Comments
 (0)