Improve clarity and utility of "VS Code - Code Navigation" tutorial #155
Description
The current version of the "VS Code - Code Navigation" tutorial is informative and useful for SE students, but there are several areas where clarity and structure can be improved.
Suggested Improvements
1. Add brief introductions for features
Many sections start with usage or shortcuts without first explaining what the feature does. For example, "Quick Open" or "Outline View" are used without context.
Action: Add 1–2 line explanations before describing usage or shortcuts.
2. Include Mac shortcut equivalents
Most shortcuts currently use Ctrl (Windows/Linux), but Mac equivalents like Cmd+T are not included in later sections.
Action: Include Mac versions of shortcuts throughout the tutorial.
3. Add troubleshooting tip boxes for missing views
Views like the Outline or Java Projects panel may not appear due to misconfiguration.
Action: Add a tip box like:
If the Outline view does not appear, ensure that: - A Java file is open - The Java extension pack is installed - Your project has a standard structure (e.g., `src/main/java`)4. Add Quick Open filter summary
Quick Open filters (@, #, :) are mentioned separately but should be summarised together.
Action: Add the following tip box:
Quick Open (`Ctrl+P`) filters: - `@` — Search symbols in current file - `#` — Search symbols in workspace - `:` — Go to line number5. Add shortcut summary table
A final reference table would help students review all shortcuts in one place.
Action: Add the following table to the end of the tutorial:
| Feature | Windows/Linux | Mac |
|---|---|---|
| Search Symbols (Workspace) | Ctrl+T |
Cmd+T |
| Search Symbols (File) | Ctrl+P, @ |
Cmd+P, @ |
| Peek Definition | Alt+F12 |
Option+F12 |
| Go to Definition | F12 |
F12 |
| Go to Super Implementation | Right-click > Go to Super Implementation | Same |
| Toggle Fold | Ctrl+K Ctrl+L |
Cmd+K Cmd+L |