-
Notifications
You must be signed in to change notification settings - Fork 23
Course Setup: VS Code page was adjusted with feedback #213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Adrianamm
wants to merge
13
commits into
frcsoftware:main
Choose a base branch
from
Adrianamm:jay-feedback
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
14abbd2
Adjusted the vscode overview page
Adrianamm 8705441
Updated from feedback
Adrianamm 9b0dfbe
removed "technical reference" from the homepage since that isn't us
Adrianamm 62fb52e
Merge branch 'main' into jay-feedback
Adrianamm f6e7736
Merge branch 'main' into jay-feedback
Adrianamm 787c044
Merge branch 'main' into jay-feedback
Adrianamm faa7caa
Merge branch 'main' into jay-feedback
Adrianamm 84cdc55
Merge branch 'main' into jay-feedback
Adrianamm 815cfda
Merge branch 'main' into jay-feedback
Adrianamm c87f3f9
updates
Adrianamm be4e9e7
Merge branch 'jay-feedback' of https://github.com/Adrianamm/frcsoftwa…
Adrianamm 64094cd
no more there are
Adrianamm 823336d
added one drive warning
Adrianamm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file removed
BIN
-119 KB
public/learning-course/getting-started/vscode-overview/IMG_0155.webp
Binary file not shown.
Binary file removed
BIN
-62.8 KB
public/learning-course/getting-started/vscode-overview/IMG_0156.webp
Binary file not shown.
Binary file removed
BIN
-63.4 KB
public/learning-course/getting-started/vscode-overview/IMG_0157.webp
Binary file not shown.
Binary file added
BIN
+135 KB
public/learning-course/getting-started/vscode-overview/commandpalette.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+6.37 KB
public/learning-course/getting-started/vscode-overview/savedunsaved.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+135 KB
public/learning-course/getting-started/vscode-overview/vscode-explained.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+45.1 KB
public/learning-course/getting-started/vscode-overview/welcomescreen.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+50.7 KB
public/learning-course/getting-started/vscode-overview/welcomescreen2.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+5.93 KB
public/learning-course/getting-started/vscode-overview/wpilib-vscode.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,54 +9,92 @@ next: learning-course/learning-course/getting-started/forking-and-cloning | |
|
|
||
| Visual Studio Code (VS Code) is a free and open source code editor created by Microsoft. | ||
| It's available on Windows, macOS, and Linux and can support virtually every programming language through available extensions on its Extension Marketplace. | ||
| Some main features include IntelliSense which is a code completion tool and it allows for you to quickly look at documentation for a specific command. | ||
| It also has integrated Git support which lets you stage, commit, push, pull, and view diffs from the Source Control panel without leaving the editor. | ||
|
|
||
| --- | ||
| In a previous page, you downloaded the WPILib tools which downloads WPILib VSCode. | ||
| In FRC, this is the VS Code that you want to use. | ||
| WPILib VS Code is installed with the other WPILib tools and is it's own separate application. | ||
| If you've installed VSCode before, make sure to use the WPILib specific one to program your robot. | ||
|
|
||
| ## Welcome Screen | ||
| The WPILib VS Code has a different icon compared to VS Code. | ||
| As shown in the photo, the WPILib VSCode has the WPILib logo while VS Code is the blue logo. | ||
|
|
||
| <ContentFigure | ||
| width="564" | ||
| height="300" | ||
| alt="VS Code welcome screen (credit: WPILib docs)" | ||
| src="/learning-course/getting-started/vscode-overview/IMG_0156.webp" | ||
| width="200px" | ||
| height="200px" | ||
| alt="VS Code interface" | ||
| src="/learning-course/getting-started/vscode-overview/wpilib-vscode.webp" | ||
| /> | ||
|
|
||
| When you first open up VS Code, you are greeted with a welcome screen that has a few options. | ||
| It lets you quickly customize settings and also lets you watch some tutorial videos. | ||
| It also has options to create a file, open a file, open a project, and clone a Git repository. | ||
| ## Welcome Screen | ||
|
|
||
| When you first open up WPILib VS Code, you are greeted with a welcome screen that has a few options. | ||
| The most helpful options are: | ||
|
|
||
| 1. New file | ||
| 2. Open file | ||
| 3. Open folder | ||
|
|
||
| New File creates a new file. | ||
| Open file lets you open a file from your computer. | ||
| Open folder lets you open a folder from your computer. | ||
| This will be the most helpful when going through each stage of this website. | ||
|
|
||
| <ContentFigure | ||
| width="564px" | ||
| height="300px" | ||
| alt="VS Code welcome page" | ||
| src="/learning-course/getting-started/vscode-overview/welcomescreen.webp" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| These options are always available by selecting "File" on the top right of the screen. | ||
| This will bring down a new window and you can select the needed option. | ||
|
|
||
| <ContentFigure | ||
| width="564px" | ||
| height="300px" | ||
| alt="VS Code welcome page with the file dropdown shown" | ||
| src="/learning-course/getting-started/vscode-overview/welcomescreen2.webp" | ||
| /> | ||
|
|
||
| <Aside type="note"> | ||
| When opening a new folder, VS Code will have a message that asks "Do you | ||
| trust the authors of the files in this folder?" For this website, you can | ||
| click "Yes, I trust the authors". | ||
| </Aside> | ||
|
|
||
| ## Navigating the Interface | ||
|
|
||
| VS Code's layout is categorized into a few key regions: | ||
|
|
||
| - The **Activity Bar** which is in the far left, consists of vertical icons which can be used to switch between the major views (Explorer, Search, Source Control, Run & Debug, Extensions). | ||
| - Next, the **Side Bar** which is next to the activity bar shows details for the selected view (for example: file tree in Explorer). | ||
| - After that, the **Editor** is the center area. | ||
| The editor is star of the show and it is where you can view and edit files. | ||
| - Next, the **Panel** is at the bottom of the screen. | ||
| It has four main views, which are the Terminal, Problems, Output, and Debug Console. | ||
| - Finally, the **Command Palette** is accesed through `Ctrl+Shift+P` / `Cmd+Shift+P` and it allows for you to search and run any command in VS Code. | ||
| 1. **Activity Bar** which is in the far left, consists of vertical icons which can be used to switch between the major views (Explorer, Search, Source Control, Run & Debug, Extensions). | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this a numbered list? Are they in this order for a reason?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. matches the photo |
||
| 2. **Side Bar** which is next to the activity bar shows details for the selected view (for example: file tree in Explorer). | ||
| 3. **Editor** is the center area. | ||
| The editor is star of the show and it is where you can view and edit files. | ||
| 4. **Panel** is at the bottom of the screen. | ||
| It has four main views, which are the Terminal, Problems, Output, and Debug Console. | ||
|
Adrianamm marked this conversation as resolved.
|
||
| 5. **Command Palette** is accessed through `Ctrl+Shift+P` / `Cmd+Shift+P` and it allows for you to search and run any command in VS Code. | ||
|
|
||
| <ContentFigure | ||
| width="564" | ||
| height="300" | ||
| width="564px" | ||
| height="300px" | ||
| alt="VS Code interface" | ||
| src="/learning-course/getting-started/vscode-overview/IMG_0157.webp" | ||
| src="/learning-course/getting-started/vscode-overview/vscode-explained.webp" | ||
| /> | ||
|
|
||
| **Useful keyboard shortcuts:** | ||
| ### WPILib Command Palette | ||
|
|
||
| - `Ctrl+P` / `Cmd+P` is Quick Open which allows you to open any file by name | ||
| - `Ctrl+Shift+P` / `Cmd+Shift+P` opens the Command Palette | ||
| - `` Ctrl+` `` allows you to quickly open and close the integrated terminal | ||
| - `Ctrl+B` / `Cmd+B` allows you to toggle sidebar visibility | ||
| - `Ctrl+Tab` allows for you switch between the open editors | ||
| One key feature of WPILib VS Code is the commands available that are specific to FRC, such as **Build** which lets you compile the robot code and check for errors on-device, and **Deploy** which builds the code and sends it over the network connection with the robot to Systemcore. | ||
|
Adrianamm marked this conversation as resolved.
Outdated
|
||
| These commands are available through the Command Palette. | ||
|
|
||
| --- | ||
| <ContentFigure | ||
| width="564px" | ||
| height="300px" | ||
| alt="WPILib Commands Palette" | ||
| src="/learning-course/getting-started/vscode-overview/commandpalette.webp" | ||
| /> | ||
|
|
||
| ## Saving and Opening Files | ||
|
|
||
|
|
@@ -73,26 +111,25 @@ VS Code's layout is categorized into a few key regions: | |
| - **Save as (new name/location):** `Ctrl+Shift+S` / `Cmd+Shift+S` | ||
| - **Save all open files:** `Ctrl+K S` / `Cmd+K S` | ||
|
|
||
| <Aside type="tip">**Auto Save:** can be enabled via `File > Auto Save` which saves your work automatically after a pause, making it way harder to lose your work. </Aside> | ||
| <Aside type="tip">**Auto Save** can be enabled via `File > Auto Save` which saves your work automatically after a pause, making it way harder to lose your work. </Aside> | ||
|
|
||
| A dot on a file's tab indicates **unsaved changes**; it turns into an "X" (close icon) once the file is saved. | ||
|
Adrianamm marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
|
|
||
| ## WPILib VS Code | ||
|
|
||
| For FRC, you use a separate version of VS Code developed by WPILib which is part of the WPILib installer. | ||
| If you already have VS Code installed on your computer, the WPILib VS Code installs seperately with the WPILib extension already installed and some settings changed. | ||
|
|
||
| ### WPILib Commands | ||
|
|
||
| One key feature of WPILib VS Code and the WPILib extension is the commands available that are specific to FRC, such as **Build** which lets you compile the robot code and check for errors on-device, and **Deploy** which builds the code and sends it over the network connection with the robot to Systemcore. | ||
|
|
||
| <ContentFigure | ||
| width="564" | ||
| height="300" | ||
| alt="WPILib Commands" | ||
| src="/learning-course/getting-started/vscode-overview/IMG_0155.webp" | ||
| width="600px" | ||
| height="600px" | ||
| alt="Left side shows the file DriveTrain.java with a dot next to the name, right side shows the same file with an X next to the name instead." | ||
| src="/learning-course/getting-started/vscode-overview/savedunsaved.webp" | ||
| /> | ||
|
|
||
| To access the WPILib commands, which are shows in the large red box on the screenshot, you can either open the command palette using the keyboard shortcut `Ctrl+Shift+P` / `Cmd+Shift+P`, or by clicking the WPILib logo in the top right corner, where the arrow is pointing to on the screenshot. | ||
| ## Keyboard shortcuts | ||
|
|
||
| VS Code has many useful keyboard shortcuts. | ||
| They also have a [list that you can refer to.](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf) | ||
| However, the most useful ones are: | ||
|
|
||
| - `Ctrl+P` / `Cmd+P` is Quick Open which allows you to open any file by name | ||
| - `Ctrl+Shift+P` / `Cmd+Shift+P` opens the Command Palette | ||
| - `` Ctrl+` `` allows you to quickly open and close the integrated terminal | ||
| - `Ctrl+B` / `Cmd+B` allows you to toggle sidebar visibility | ||
| - `Ctrl+Tab` allows for you switch between the open editors | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.