Skip to content

Commit 508d47e

Browse files
author
GitHub Workshop Bot
committed
docs: add VS Code Profiles section, fix diagram, refs, and appendix counts
Chapter 5: - Add Profiles subsection to Settings Sync (create, switch, export, share) - Add accessible text description below ASCII layout diagram - Fix keyboard shortcuts link (was pointing to wrong Copilot section) - Fix Git operations cross-reference (Chapter 11, not Chapter 6) - Add Profiles entry to Table of Contents Appendix M: - Add cross-link to Ch5 Profiles from settings examples section Appendix Y, README, GITHUB_PROPOSAL: - Update appendix counts from 25/26 to 31 (A-Z, AA-AE) - Update document counts and appendix listings to match current state
1 parent 2151f4c commit 508d47e

File tree

5 files changed

+112
-13
lines changed

5 files changed

+112
-13
lines changed

GITHUB_PROPOSAL.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ Accessibility is woven into every chapter.
243243
## Implementation & Deployment
244244

245245
### Current Assets
246-
- **34 Markdown documents** (16 core chapters + 1 setup guide + 16 appendices A-Q + Accessibility Agents)
246+
- **49 Markdown documents** (16 core chapters + 1 setup guide + 31 appendices A-Z, AA-AE + Accessibility Agents)
247247
- **6 AI agents** fully defined and integrated
248248
- **10 hands-on exercises** with detailed walkthroughs
249249
- **4 supporting guides** (Quick Reference, Troubleshooting, Resources, FAQ)
@@ -416,16 +416,21 @@ Open curriculum invites contributions:
416416
## Budget & Resources
417417
418418
### Current Assets (Complete)
419-
- **34 Markdown chapters** (~110,000 words total)
419+
- **49 Markdown chapters** (~200,000 words total)
420420
- 16 core chapters (01-16)
421421
- 1 pre-workshop setup guide (00)
422-
- 16 appendices A-Q (no M) with reference material
423-
- A: Glossary, B: Screen Reader Cheatsheet, C: Git Authentication
424-
- D: Gists, E: Advanced Features, F: VS Code A11y Reference
425-
- G: GitHub Actions, H: GitHub Projects, I: GitHub Discussions
426-
- J: Advanced Search, K: Releases & Tags, L: Repository Insights
427-
- N: GitHub Flavored Markdown [NEW], O: GitHub Security [NEW]
428-
- P: Branch Protection [NEW], Q: Resources
422+
- 31 appendices (A-Z, AA-AE) with reference material
423+
- A: Glossary, B: Screen Reader Cheatsheet, C: Accessibility Standards
424+
- D: Git Authentication, E: GitHub Flavored Markdown, F: Gists
425+
- G: Discussions, H: Releases/Tags/Insights, I: GitHub Projects
426+
- J: Advanced Search, K: Branch Protection/Rulesets, L: Security Features
427+
- M: VS Code Accessibility Reference, N: Codespaces, O: GitHub Mobile
428+
- P: GitHub Pages, Q: GitHub Actions, R: Profile/Sponsors/Wikis
429+
- S: Organizations/Templates, T: Contributing to Open Source, U: Resources
430+
- V: Accessibility Agents Reference, W: Copilot Reference, X: AI Models
431+
- Y: Accessing Workshop Materials, Z: GitHub Skills Catalog
432+
- AA: Advanced Git, AB: GitHub Desktop, AC: GitHub CLI
433+
- AD: Git Security, AE: GitHub Social
429434
- Accessibility Agents (Chapter 16 + 54+ slash commands)
430435
- **55 AI agents** across 3 teams (fully documented, ready to use)
431436
- Integrated throughout curriculum

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ The Facilitator guide includes templates, scripts, success metrics, and a final
252252
│ ├── feed.xml ← RSS 2.0 podcast feed
253253
│ ├── README.md ← Production guide
254254
│ └── bundles/ ← 44 generated episode source bundles
255-
└── docs/ ← Full workshop curriculum (17 lessons + 26 appendices A-Z)
255+
└── docs/ ← Full workshop curriculum (17 lessons + 31 appendices A-Z, AA-AE)
256256
├── course-guide.md ← Student landing page: day-by-day overview, exercises, help
257257
├── 00-pre-workshop-setup.md
258258
├── 01-understanding-github-web-structure.md ← How GitHub is organized (start here)

docs/05-vscode-accessibility.md

Lines changed: 94 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ Tool setup is part of contribution skill. A stable, accessible editor reduces st
107107
7. [The Status Bar](#7-the-status-bar)
108108
8. [The Menu Bar](#8-the-menu-bar)
109109
9. [Settings Sync](#9-settings-sync)
110+
- [Profiles](#profiles)
110111
10. [The Settings Editor](#10-the-settings-editor)
111112
11. [The Keyboard Shortcuts Editor](#11-the-keyboard-shortcuts-editor)
112113
12. [Essential Keyboard Navigation and Find/Filter](#12-essential-keyboard-navigation-and-findfilter)
@@ -203,7 +204,7 @@ Change the domain in any GitHub URL:
203204
Everything in the list below works **exactly like desktop VS Code**:
204205

205206
- **Full text editor with syntax highlighting**
206-
- **All VS Code keyboard shortcuts** (see [Keyboard Reference](13-github-copilot.md#8-keyboard-shortcuts-reference))
207+
- **All VS Code keyboard shortcuts** (see [Section 11: Keyboard Shortcuts Editor](#11-the-keyboard-shortcuts-editor) and [Appendix M](appendix-m-vscode-accessibility-reference.md#5-complete-keyboard-shortcuts))
207208
- **Screen reader mode** (`Shift+Alt+F1` to activate - Mac: `Shift+Option+F1`)
208209
- **File Explorer** (`Ctrl+Shift+E` - Mac: `Cmd+Shift+E`) - browse the entire repository
209210
- **Search across files** (`Ctrl+Shift+F` - Mac: `Cmd+Shift+F`)
@@ -385,6 +386,8 @@ Before diving into individual features, here is how VS Code is organized. Every
385386
+------+---------------------------------------------------+
386387
```
387388

389+
**Text description of the layout above:** VS Code has five major regions arranged in a grid. The **Menu Bar** spans the full width across the top. Below it, the **Activity Bar** runs vertically along the left edge (it contains icons for Explorer, Source Control, Search, Extensions, and more). The **Sidebar** appears to the right of the Activity Bar and shows content for the selected activity (file tree, search results, etc.). The **Editor Area** fills the large central region where your files open. Below the Editor Area, the **Panel** stretches across the bottom and contains the Terminal, Problems, Output, and Debug Console tabs. Finally, the **Status Bar** runs along the very bottom showing line number, column, language mode, Git branch, Copilot status, encoding, and notifications.
390+
388391
### Navigating Between Regions
389392

390393
| Region | Keyboard Shortcut | What You Hear (Screen Reader) |
@@ -748,6 +751,95 @@ If settings differ between machines, VS Code shows a merge editor where you choo
748751

749752
</details>
750753

754+
### Profiles
755+
756+
VS Code **Profiles** let you create named collections of settings, extensions, keyboard shortcuts, snippets, tasks, and UI state. Each profile is independent - switching profiles changes your entire VS Code configuration instantly. This is useful when you work in different contexts (workshop vs. daily development) or need to present with different display settings.
757+
758+
#### Creating a Profile
759+
760+
| Method | Steps |
761+
| --- | --- |
762+
| Command Palette | `Ctrl+Shift+P` then type `Profiles: Create Profile` |
763+
| Gear menu | Click the gear icon (bottom-left of Activity Bar) then `Profiles` then `Create Profile` |
764+
765+
When creating a profile, you choose what to include:
766+
767+
- **Settings** - editor preferences, accessibility options, theme
768+
- **Keyboard Shortcuts** - all custom keybindings
769+
- **Extensions** - which extensions are installed and enabled
770+
- **Snippets** - code snippet definitions
771+
- **Tasks** - task runner configurations
772+
- **UI State** - sidebar position, panel layout, view visibility
773+
774+
You can start from the current configuration, an empty profile, or an existing profile template.
775+
776+
#### Switching Profiles
777+
778+
| Method | Steps |
779+
| --- | --- |
780+
| Command Palette | `Ctrl+Shift+P` then type `Profiles: Switch Profile` |
781+
| Gear menu | Click the gear icon then `Profiles` then select a profile name |
782+
| Status Bar | The current profile name appears in the Status Bar when you are not using the Default profile - click it to switch |
783+
784+
The active profile name appears in the VS Code title bar and Status Bar so you always know which configuration is active.
785+
786+
#### Workshop Profile Recommendations
787+
788+
Create these profiles before the workshop:
789+
790+
| Profile Name | Purpose | Key Settings |
791+
| --- | --- | --- |
792+
| **Workshop** | Accessibility-optimized for this event | Screen reader mode on, accessibility signals enabled, minimap off, word wrap on (see the [Recommended Workshop Profile](#recommended-workshop-profile) settings in Section 17) |
793+
| **Presentation** | Large fonts for demos or shared screens | `editor.fontSize: 24`, `terminal.integrated.fontSize: 20`, `window.zoomLevel: 2`, High Contrast theme |
794+
| **Default** | Your everyday development settings | Whatever you normally use |
795+
796+
#### Exporting and Sharing Profiles
797+
798+
Profiles can be exported and shared:
799+
800+
1. `Ctrl+Shift+P` then type `Profiles: Export Profile`
801+
2. Choose what to include (settings, extensions, etc.)
802+
3. Export as a **GitHub gist** (shareable link) or a **local file**
803+
4. Share the link or file with others
804+
805+
To import: `Ctrl+Shift+P` then `Profiles: Import Profile` and paste the gist URL or select the file.
806+
807+
**Workshop tip:** Facilitators can export a pre-configured Workshop profile as a GitHub gist and share the link. Students import it in one step and immediately have all accessibility settings configured.
808+
809+
#### Profiles and Settings Sync
810+
811+
Profiles sync across machines through Settings Sync. When you create a profile on one machine and have Settings Sync enabled, the profile appears on every other machine where you are signed in. Each profile syncs independently - changes to one profile do not affect others.
812+
813+
#### Learning Cards: Profiles
814+
815+
<details>
816+
<summary>Screen reader users</summary>
817+
818+
- The Command Palette is the fastest way to switch profiles: `Ctrl+Shift+P` then type `Switch Profile`
819+
- Your screen reader announces the profile name when you switch - listen for the confirmation
820+
- Create a **Workshop** profile with `editor.accessibilitySupport: "on"` and all your accessibility signals configured, so you can switch to it instantly at the start of each session
821+
- The Default profile is always available as a fallback
822+
823+
</details>
824+
825+
<details>
826+
<summary>Low vision users</summary>
827+
828+
- Create a **Presentation** profile with large fonts, high zoom, and a High Contrast theme for pair programming or demos
829+
- Switching profiles changes everything at once - no need to adjust multiple settings individually
830+
- The current profile name in the title bar confirms which configuration is active
831+
832+
</details>
833+
834+
<details>
835+
<summary>Sighted users</summary>
836+
837+
- The gear icon in the Activity Bar (bottom-left) provides quick access to profile management
838+
- Profile names appear in the title bar so you always know your current context
839+
- Export your team's recommended profile as a GitHub gist for easy onboarding
840+
841+
</details>
842+
751843

752844
---
753845

@@ -1845,7 +1937,7 @@ On Linux, the extension requires the ALSA shared library (`libasound`). Install
18451937

18461938
## 19. Git Operations Inside VS Code
18471939

1848-
This section previews the key Git operations you will perform inside VS Code. [Chapter 6 (Git & Source Control)](11-git-source-control.md) covers each in full detail with step-by-step walkthroughs. This is your orientation.
1940+
This section previews the key Git operations you will perform inside VS Code. [Chapter 11 (Git & Source Control)](11-git-source-control.md) covers each in full detail with step-by-step walkthroughs. This is your orientation.
18491941

18501942
### Cloning a Repository
18511943

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -601,6 +601,8 @@ This prevents overlapping announcements.
601601

602602
## 7. Settings.json Configuration Examples
603603

604+
The configuration examples below are JSON blocks you paste into your `settings.json` file. To apply a complete set at once, consider using **VS Code Profiles** -- named configuration bundles that let you switch your entire setup instantly. See [Chapter 5, Section 9: Profiles](05-vscode-accessibility.md#profiles) for how to create, switch, export, and share profiles.
605+
604606
### Minimal Screen Reader Profile
605607

606608
#### For users who prefer minimal announcements and use Accessible View manually

docs/appendix-y-accessing-workshop-materials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ If you have already cloned the repo, every file is already on your computer. Ope
117117

118118
| Folder | Contents | Format |
119119
| -------- | ---------- | -------- |
120-
| `docs/` | All 17 chapters (00-16) and 25 appendices (A-Y) | Markdown (`.md`) |
120+
| `docs/` | All 17 chapters (00-16) and 31 appendices (A-Z, AA-AE) | Markdown (`.md`) |
121121
| `html/` | Pre-built HTML versions of every Markdown file | HTML (`.html`) |
122122
| `html/docs/` | HTML versions of all chapters and appendices | HTML (`.html`) |
123123
| `learning-room/` | Practice repository files: challenges, group exercises, setup guides | Markdown (`.md`) |

0 commit comments

Comments
 (0)