Skip to content

Commit e489f12

Browse files
committed
Diagrams: plain text descriptions with clean Mermaid, tables to prose
1 parent f6d25fe commit e489f12

8 files changed

Lines changed: 47 additions & 106 deletions

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

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -194,24 +194,10 @@ Your personal home (`github.com`) shows activity from repositories you follow. Y
194194

195195
## 5. Visual Map of a Repository Page
196196

197-
This diagram shows the layout of a repository home page, from top to bottom:
198-
199-
1. **Global Navigation** (landmark: "Navigation Menu") — GitHub logo, Search, Copilot, Pull Requests, Issues, Notifications bell, and your avatar.
200-
2. **Repository Tabs** (landmark: "Repository navigation") — Code, Issues (12), Pull requests (3), Actions, and more.
201-
3. **Repository Header** — The H1 heading "owner / repo-name" plus Star (42), Watch, and Fork (8) buttons.
202-
4. **Main content area** split into two columns:
203-
- **Left: File Area** — Branch selector (main), Go to file button, Code button, and the File Table (a landmark) listing files like .github/, docs/, README.md with dates.
204-
- **Right: Sidebar** — About section, description text, topics (accessibility), Releases (3), Contributors (5), Languages (Markdown 100%).
205-
5. **README** (landmark: "Repository files navigation") — The rendered README content.
206-
6. **Footer**
207-
208-
<details>
209-
<summary>Visual diagram (Mermaid)</summary>
197+
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.
210198

211199
```mermaid
212200
graph TD
213-
accTitle: Repository page layout
214-
accDescr: A GitHub repository page has a global navigation bar at top, then repository tabs, the repository header with star/watch/fork, a two-column layout with file area on left and sidebar on right, the rendered README below, and a footer.
215201
NAV["Global Navigation\nGitHub, Search, Copilot, PRs, Issues, Bell, You"]
216202
NAV --> TABS["Repository Tabs\nCode, Issues 12, Pull requests 3, Actions"]
217203
TABS --> HEADER["Repository Header\nowner / repo-name (H1)\nStar 42, Watch, Fork 8"]
@@ -222,14 +208,9 @@ graph TD
222208
README --> FOOTER["Footer"]
223209
```
224210

225-
</details>
226-
227211
### Screen reader navigation of this page
228212

229-
- `1` → hear "owner/repo-name" (the H1, confirms you are on the right repo)
230-
- `D` → "Navigation Menu" → `D` → "Repository navigation" → `D` → "Main" (file tree area)
231-
- `T` → jump to the file table → `Ctrl+Alt+Down Arrow` to navigate rows
232-
- `D` → "Repository files navigation" → read the README
213+
Press 1 to hear "owner/repo-name" (the H1, confirms you are on the right repo). Press D to hear "Navigation Menu," then D again for "Repository navigation," then D again for "Main" (the file tree area). Press T to jump to the file table, then Ctrl+Alt+Down Arrow to navigate rows. Press D again to reach "Repository files navigation" and read the README.
233214

234215

235216
## 6. Screen Reader Orientation Sequence

docs/02-navigating-repositories.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,10 @@ Use this sequence before moving to graded chapters:
2929

3030
When you navigate to a GitHub repository (e.g., `https://github.com/owner/repo-name`), you land on the **repository home page** (also called the Code tab). This page has several distinct regions:
3131

32-
The repository home page is organized into these regions, from top to bottom:
33-
34-
1. **Navigation bar** (GitHub global nav) — avatar menu, Notifications, search.
35-
2. **Repository header** — "owner / repo-name" as the H1 heading, plus Star, Watch, and Fork buttons.
36-
3. **Repository navigation tabs** (landmark) — Code (active), Issues, Pull requests, Actions, and more.
37-
4. **Main content area** split into two columns:
38-
- **Left: File tree / code panel** — Branch selector, Files table (navigable as a table), last commit message.
39-
- **Right: Sidebar** — About section, topics, releases.
40-
5. **README.md** (rendered) — A separate landmark region below the file tree.
41-
42-
<details>
43-
<summary>Visual diagram (Mermaid)</summary>
32+
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.
4433

4534
```mermaid
4635
graph TD
47-
accTitle: Repository page layout
48-
accDescr: A repository page has a navigation bar at top, then the repository header, navigation tabs, a two-column area with file tree on the left and sidebar on the right, and the rendered README below.
4936
NAV["Navigation bar\navatar menu, Notifications, search"]
5037
NAV --> HEADER["Repository header\nowner / repo-name (H1)\nStar, Watch, Fork"]
5138
HEADER --> TABS["Repository navigation tabs\nCode, Issues, Pull requests, Actions"]
@@ -55,8 +42,6 @@ graph TD
5542
SIDEBAR --> README
5643
```
5744

58-
</details>
59-
6045

6146
## Landing on a Repository - What to Expect
6247

docs/03-the-learning-room.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,8 @@ 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-
<details>
29-
<summary>Visual diagram (Mermaid)</summary>
30-
3128
```mermaid
3229
graph TD
33-
accTitle: Learning room branch structure
34-
accDescr: The shared learning-room repository has a protected main branch. Students open pull requests assigned to each other for peer review. Merged PRs are closed.
3530
LR["learning-room (SHARED)"]
3631
LR --> MAIN["main branch (protected)"]
3732
LR --> PR12["Student A's PR #12\nopen, assigned to Student B for review"]
@@ -41,8 +36,6 @@ graph TD
4136
LR --> MORE["More PRs as students contribute"]
4237
```
4338

44-
</details>
45-
4639
### Why one shared repo?
4740

4841
- **Realistic** - Open source projects are shared spaces

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -192,13 +192,8 @@ 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-
<details>
196-
<summary>Visual diagram (Mermaid)</summary>
197-
198195
```mermaid
199196
graph TD
200-
accTitle: GitHub Pull Requests panel tree structure
201-
accDescr: The panel has two sections. My Pull Requests contains Assigned to Me, Created by Me, Waiting for my Review, and All Open. The Repository section shows Local Branches, All Open, and All Closed.
202197
ROOT["GitHub Pull Requests"]
203198
ROOT --> MY["My Pull Requests"]
204199
MY --> ASSIGNED["Assigned to Me"]
@@ -211,8 +206,6 @@ graph TD
211206
REPO --> CLOSED["All Closed Pull Requests"]
212207
```
213208

214-
</details>
215-
216209
#### Screen reader announcement example
217210

218211
"Pull Request #42: Add Timeline Guide, opened by jeffb, 2 days ago, 3 files changed"

docs/15-issue-templates.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -195,13 +195,8 @@ 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-
<details>
199-
<summary>Visual diagram (Mermaid)</summary>
200-
201198
```mermaid
202199
graph TD
203-
accTitle: Issue template folder structure
204-
accDescr: Templates live in your-repo/.github/. The ISSUE_TEMPLATE subfolder has bug_report.md, feature_request.md, accessibility-bug.yml, and config.yml. The pull_request_template.md sits directly in .github/.
205200
REPO["your-repo/"]
206201
REPO --> GH[".github/"]
207202
GH --> IT["ISSUE_TEMPLATE/"]
@@ -212,8 +207,6 @@ graph TD
212207
GH --> PRT["pull_request_template.md\nPR template (singular)"]
213208
```
214209

215-
</details>
216-
217210
**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.
218211

219212
**YAML form templates (`.yml`):** Modern form-based templates. Creates a proper form interface with labeled fields, dropdowns, checkboxes, and validation. Contributors fill in fields rather than editing freeform Markdown. Better for accessibility because each field has an explicit label announced by screen readers.

docs/appendix-i-github-projects.md

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,17 @@
2727

2828
GitHub has two generations of project tooling. The current generation - called **Projects (v2)** - is what you'll find on any repository or organization page today.
2929

30-
| Feature | Classic Projects (v1) | Projects v2 (current) |
31-
| --- | --- | --- |
32-
| Layouts | Kanban board only | Board, Table, Roadmap |
33-
| Custom fields | None | Text, Number, Date, Select, Iteration |
34-
| Automations | None built-in | Native GitHub Actions integration |
35-
| Cross-repo | No | Yes |
36-
| Filtering | Limited | Full field/label/assignee/status queries |
37-
| API | Limited | Full GraphQL support |
30+
**Layouts:** Classic v1 offered Kanban board only. V2 offers Board, Table, and Roadmap.
31+
32+
**Custom fields:** Classic v1 had none. V2 supports Text, Number, Date, Single Select, and Iteration fields.
33+
34+
**Automations:** Classic v1 had no built-in automations. V2 has native GitHub Actions integration.
35+
36+
**Cross-repo support:** Classic v1 did not support cross-repository tracking. V2 does.
37+
38+
**Filtering:** Classic v1 had limited filtering. V2 supports full field, label, assignee, and status queries.
39+
40+
**API:** Classic v1 had a limited API. V2 has full GraphQL support.
3841

3942
If you see "Projects (Beta)" references in older documentation, those referred to the early rollout of v2. It is now stable and the default.
4043

@@ -143,13 +146,15 @@ This is one of Projects v2's most powerful features. You can add fields beyond t
143146

144147
### Field Types
145148

146-
| Type | Use Case | Example |
147-
| --- | --- | --- |
148-
| **Text** | Free-form notes | "Acceptance criteria", "Design link" |
149-
| **Number** | Story points, estimates | "Points: 3" |
150-
| **Date** | Deadlines, start dates | "Due: 2025-06-15" |
151-
| **Single select** | Priority, size, type | Priority: P0 / P1 / P2 |
152-
| **Iteration** | Sprint/cycle tracking | See Section 7 |
149+
**Text:** Free-form notes for things like acceptance criteria or design links.
150+
151+
**Number:** Numeric values such as story points or estimates (for example, "Points: 3").
152+
153+
**Date:** Deadlines or start dates (for example, "Due: 2025-06-15").
154+
155+
**Single select:** A dropdown with predefined options, useful for priority, size, or type fields (for example, Priority: P0, P1, or P2).
156+
157+
**Iteration:** Sprint or cycle tracking. See Section 7 for details.
153158

154159
### Creating a Custom Field
155160

@@ -234,13 +239,15 @@ From a project:
234239

235240
### Available Built-In Workflows
236241

237-
| Workflow | What It Does |
238-
| --- | --- |
239-
| **Item added to project** | When an item is manually added, set its Status to a chosen value |
240-
| **Item reopened** | When an issue/PR is reopened, change its Status (e.g., back to "In Progress") |
241-
| **Item closed** | When an issue/PR is closed, set Status to "Done" automatically |
242-
| **Pull request merged** | When a PR is merged, set its Status to "Done" |
243-
| **Auto-add to project** | Items matching a filter (by label, type, repo) are automatically added to the project |
242+
**Item added to project:** When an item is manually added, its Status is set to a value you choose.
243+
244+
**Item reopened:** When an issue or pull request is reopened, its Status changes back (for example, to "In Progress").
245+
246+
**Item closed:** When an issue or pull request is closed, its Status is automatically set to "Done."
247+
248+
**Pull request merged:** When a pull request is merged, its Status is set to "Done."
249+
250+
**Auto-add to project:** Items matching a filter (by label, type, or repository) are automatically added to the project.
244251

245252
### Setting Up Auto-Add
246253

@@ -307,18 +314,21 @@ A **view** is a saved configuration of layout + filters + grouping + sort. You c
307314

308315
The filter bar accepts a query language similar to GitHub's issue search:
309316

310-
| Query | Meaning |
311-
| --- | --- |
312-
| `status:In Progress` | Show only items with that Status value |
313-
| `assignee:@me` | Show only items assigned to you |
314-
| `label:accessibility` | Items with the accessibility label |
315-
| `milestone:"v2.0"` | Items in a specific milestone |
316-
| `no:assignee` | Items with no assignee |
317-
| `is:pr` | Only pull requests |
318-
| `is:issue` | Only issues |
319-
| `repo:owner/name` | Items from a specific repo (cross-repo projects) |
320-
321-
Combine filters: `assignee:@me status:"In Progress"` shows your in-progress work.
317+
`status:In Progress` shows only items with that Status value.
318+
319+
`assignee:@me` shows only items assigned to you.
320+
321+
`label:accessibility` shows items with the accessibility label.
322+
323+
`milestone:"v2.0"` shows items in a specific milestone.
324+
325+
`no:assignee` shows items with no assignee.
326+
327+
`is:pr` shows only pull requests. `is:issue` shows only issues.
328+
329+
`repo:owner/name` shows items from a specific repository, useful in cross-repo projects.
330+
331+
You can combine filters: `assignee:@me status:"In Progress"` shows your in-progress work.
322332

323333
### Grouping
324334

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,13 +177,8 @@ 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-
<details>
181-
<summary>Visual diagram (Mermaid)</summary>
182-
183180
```mermaid
184181
graph TD
185-
accTitle: Accessible Diff Viewer structure
186-
accDescr: The viewer has a header with file path and change summary, then hunks containing line ranges, unchanged context, and modified lines. A footer shows total additions and deletions.
187182
ROOT["Accessible Diff Viewer"]
188183
ROOT --> HEADER["Header\nfile path, change summary"]
189184
ROOT --> H1["Hunk 1 of N"]
@@ -195,8 +190,6 @@ graph TD
195190
ROOT --> FOOTER["Footer\ntotals: X additions, Y deletions"]
196191
```
197192

198-
</details>
199-
200193
#### Line prefixes
201194

202195
| Prefix | Meaning | Screen Reader Announcement |

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,8 @@ 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-
<details>
61-
<summary>Visual diagram (Mermaid)</summary>
62-
6360
```mermaid
6461
graph TD
65-
accTitle: GitHub Actions workflows folder structure
66-
accDescr: Workflow files live at your-repository/.github/workflows/. Contains ci.yml for tests, lint.yml for code style, a11y-scan.yml for accessibility scanning, and deploy.yml for deployment.
6762
REPO["your-repository/"]
6863
REPO --> GH[".github/"]
6964
GH --> WF["workflows/"]
@@ -73,8 +68,6 @@ graph TD
7368
WF --> DEPLOY["deploy.yml\nDeploys on merge to main"]
7469
```
7570

76-
</details>
77-
7871
The `.github/` folder is hidden by convention (starts with a dot). To find it:
7972

8073
- **On GitHub.com:** The file browser shows it - use `T` (go to file) or navigate the file table with `Ctrl+Alt+Arrow` keys

0 commit comments

Comments
 (0)