Skip to content

Commit b1b5f3a

Browse files
committed
Convert ASCII art diagrams to SVG images
1 parent 7b147b5 commit b1b5f3a

15 files changed

Lines changed: 274 additions & 101 deletions

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

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -196,34 +196,7 @@ Your personal home (`github.com`) shows activity from repositories you follow. Y
196196

197197
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.
198198

199-
```text
200-
+----------------------------------------------------------+
201-
| GLOBAL NAVIGATION (landmark: "Navigation Menu") |
202-
| [GitHub] [Search] [Copilot] [PRs] [Issues] [Bell] [You]|
203-
+----------------------------------------------------------+
204-
| REPOSITORY TABS (landmark: "Repository navigation") |
205-
| [Code] [Issues 12] [Pull requests 3] [Actions] [...] |
206-
+----------------------------------------------------------+
207-
| REPOSITORY HEADER |
208-
| owner / repo-name (this is the H1 heading) |
209-
| [Star 42] [Watch] [Fork 8] |
210-
+-----------------------------+----------------------------+
211-
| FILE AREA | SIDEBAR |
212-
| Branch: [main v] | About |
213-
| [Go to file] [Code v] | Description text |
214-
| | Topics: accessibility |
215-
| FILE TABLE (landmark) | Releases: 3 |
216-
| .github/ 3 days ago | Contributors: 5 |
217-
| docs/ 2 days ago | Languages: Markdown 100% |
218-
| README.md yesterday | |
219-
+-----------------------------+----------------------------+
220-
| README (landmark: "Repository files navigation") |
221-
| # Rendered README content here |
222-
| ... |
223-
+----------------------------------------------------------+
224-
| FOOTER |
225-
+----------------------------------------------------------+
226-
```
199+
![Diagram showing the visual layout of a GitHub repository page from top to bottom: global navigation, repository tabs, header, file area and sidebar side by side, README, and footer](images/repo-page-layout-01.svg)
227200

228201
### Screen reader navigation of this page
229202

docs/02-navigating-repositories.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,7 @@ When you navigate to a GitHub repository (e.g., `https://github.com/owner/repo-n
3131

3232
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.
3333

34-
```text
35-
┌────────────────────────────────────────────────────┐
36-
│ Navigation bar (GitHub global nav) │
37-
│ avatar menu | Notifications | search │
38-
├────────────────────────────────────────────────────┤
39-
│ Repository header │
40-
│ owner / repo-name (h1) │
41-
│ [Star] [Watch] [Fork] buttons │
42-
├────────────────────────────────────────────────────┤
43-
│ Repository navigation tabs (landmark) │
44-
│ < Code > Issues Pull requests Actions etc. │
45-
├─────────────────────────────┬──────────────────────┤
46-
│ File tree / code panel │ Sidebar │
47-
│ Branch selector │ About section │
48-
│ Files table (t:table) │ Topics │
49-
│ Last commit message │ Releases │
50-
├─────────────────────────────┴──────────────────────┤
51-
│ README.md (rendered) │
52-
│ (a separate landmark region) │
53-
└────────────────────────────────────────────────────┘
54-
```
34+
![Diagram showing the repository page layout with navigation bar, header, tabs, file tree and sidebar columns, and README section](images/repo-page-layout-02.svg)
5535

5636

5737
## Landing on a Repository - What to Expect

docs/03-the-learning-room.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,7 @@ Before starting Chapter 4 challenges, students should be able to:
2525

2626
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.
2727

28-
```text
29-
learning-room (SHARED)
30-
├── main branch (protected)
31-
├── Student A's PR #12 (open, assigned to Student B for review)
32-
├── Student B's PR #13 (open, assigned to Student C for review)
33-
├── Student C's PR #14 (open, assigned to Student A for review)
34-
├── Student A's PR #11 (merged, closed)
35-
└── [More PRs as students contribute]
36-
```
28+
![Diagram showing the learning-room shared repository structure with a protected main branch and student pull requests](images/learning-room-tree.svg)
3729

3830
### Why one shared repo?
3931

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -192,18 +192,7 @@ gh pr list --search "review-requested:@me"
192192

193193
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.
194194

195-
```text
196-
GitHub Pull Requests
197-
├── My Pull Requests
198-
│ ├── Assigned to Me
199-
│ ├── Created by Me
200-
│ ├── Waiting for my Review
201-
│ └── All Open
202-
├── [Repository Name]
203-
│ ├── Local Pull Request Branches (checked out locally)
204-
│ ├── All Open Pull Requests
205-
│ └── All Closed Pull Requests
206-
```
195+
![Diagram showing the GitHub Pull Requests panel tree with My Pull Requests filters and repository sections](images/pr-tree.svg)
207196

208197
#### Screen reader announcement example
209198

docs/15-issue-templates.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,7 @@ Templates live in a specific folder in your repository:
195195

196196
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/.
197197

198-
```text
199-
your-repo/
200-
└── .github/
201-
├── ISSUE_TEMPLATE/
202-
│ ├── bug_report.md ← Markdown template
203-
│ ├── feature_request.md ← Markdown template
204-
│ ├── accessibility-bug.yml ← YAML form template
205-
│ └── config.yml ← Template chooser configuration
206-
└── pull_request_template.md ← PR template (singular)
207-
```
198+
![Diagram showing the template folder structure inside .github with ISSUE_TEMPLATE subfolder and PR template](images/template-folder-tree.svg)
208199

209200
**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.
210201

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -177,18 +177,7 @@ The Accessible Diff Viewer presents file diffs as a structured, line-by-line lis
177177

178178
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.
179179

180-
```text
181-
Accessible Diff Viewer
182-
├── Header (file path, change summary)
183-
├── Hunk 1 of N
184-
│ ├── Hunk location (line range)
185-
│ ├── Unchanged lines (context)
186-
│ ├── Modified/Added/Removed lines (with prefix)
187-
│ └── More unchanged lines (context)
188-
├── Hunk 2 of N
189-
│ └── ...
190-
└── Footer (totals: X additions, Y deletions)
191-
```
180+
![Diagram showing the Accessible Diff Viewer tree structure with header, hunks containing line ranges and changes, and footer](images/diff-viewer-tree.svg)
192181

193182
#### Line prefixes
194183

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,7 @@ Workflow files live in a specific, mandatory location:
5757

5858
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).
5959

60-
```text
61-
your-repository/
62-
└── .github/
63-
└── workflows/
64-
├── ci.yml ← Runs tests on every push/PR
65-
├── lint.yml ← Checks code style
66-
├── a11y-scan.yml ← Accessibility scanning
67-
└── deploy.yml ← Deploys the site when code merges to main
68-
```
60+
![Diagram showing the workflow folder structure at .github/workflows with CI, lint, accessibility, and deploy YAML files](images/workflow-folder-tree.svg)
6961

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

docs/images/diff-viewer-tree.svg

Lines changed: 13 additions & 0 deletions
Loading

docs/images/learning-room-tree.svg

Lines changed: 10 additions & 0 deletions
Loading

docs/images/pr-tree.svg

Lines changed: 13 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)