Skip to content

Commit 8b4efeb

Browse files
committed
feat(setup): write vscode section
1 parent 623fc99 commit 8b4efeb

6 files changed

Lines changed: 70 additions & 0 deletions

File tree

pages/setup.qmd

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,22 @@ GitHub will take a minute to prepare your Codespace, then open an editor in the
4646

4747
![It may look a little different from this screenshot if we have changed the repository since writing this page!](setup/open_codespace.png){fig-alt="Screenshot of the generated GitHub codespace."}
4848

49+
## Welcome to VSCode
50+
51+
When your Codespace opens, you are using **VSCode (Visual Studio Code)** in your web browser.
52+
53+
VSCode is an **IDE (Integrated Development Environment)**. That sounds technical, but in simple terms it is just an application that helps you work with files in one place. You can open, edit, and organise your project without needing lots of different tools.
54+
55+
The layout is split into a few main areas:
56+
57+
* **File explorer (left side)**: shows all the files in your project, you can click any file to open it.
58+
* **Editor (centre):** this is where you read and edit your files.
59+
* **Top tabs:** each open file appears as a tab, so you can switch between them.
60+
* **Bottom panel:** a shared area that can show different tools.
61+
* **Build with AI agent:** an optional assistant built into VSCode to help people who are writing code - we do not need this panel, so can close it by clicking the **x** on its tab.
62+
63+
![](setup/codespace_labels.drawio.png)
64+
4965
## Reopening your Codespace
5066

5167
If you close your Codespace and want to get back to it later (with all your changes still there), just return to the same GitHub repository.
@@ -58,4 +74,6 @@ Your codespace will automatically shut down after a period of inactivity (**30 m
5874

5975
By default, inactive codespaces are deleted after **30 days**.
6076

77+
<br><br>
78+
6179
For this workshop, we're using GitHub Codespaces because it's quick and easy to get started without installing anything. However, if you plan to work on similar projects regularly, we recommend **installing the required tools** (e.g., R and RStudio) on your own computer for more flexibility and long-term use.

pages/setup/codespace.png

142 KB
Loading

pages/setup/codespace_labels.drawio

Lines changed: 52 additions & 0 deletions
Large diffs are not rendered by default.
412 KB
Loading

pages/setup/open_codespace.png

53.3 KB
Loading

pages/setup/quarto-template.png

112 KB
Loading

0 commit comments

Comments
 (0)