Skip to content

Commit 634aadc

Browse files
committed
Update walkthrough based on feedback
- Add additional pictures to clarify certain instructions - Update the GIFs for testing view and DocC preview - Ensure that each step has a unique completion action to ensure that the checkbox is only checked after that step is viewed
1 parent a0614ec commit 634aadc

File tree

13 files changed

+33
-22
lines changed

13 files changed

+33
-22
lines changed

assets/walkthrough/createNewProject.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,12 @@ Once you select a template, you'll be prompted to enter a name for your new proj
1414

1515
Finally, you'll be prompted to select a location for your new project. You can choose any location in your workspace, or create a new folder.
1616

17+
# Opening Existing Projects
18+
1719
![Open existing project](./images/openProject.gif)
1820

1921
When you open an existing project with a ``Package.swift`` file the extension will start automatically.
2022

21-
Tip: You can view more information about the toolchain and other configurations being used for the project by hovering over the `{}` icon in the status bar.
23+
Tip: You can view more information about the toolchain and other configurations being used for the project by hovering over the `{}` icon in the bottom right corner of the status bar.
24+
25+
![Hover over {} to see toolchain info](./images/toolchainInfo.png)

assets/walkthrough/customizeSettings.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
![Swift Extension Settings](./images/settings.gif)
44

5-
The Swift Extension contains several settings you can customize.
6-
7-
## Workspace Settings
8-
9-
**Add details about custom workspace settings and environment variable here.**
5+
The Swift Extension contains several settings you can customize. You can filter settings Swift extension settings by searching for `@ext:swiftlang.swift-vscode`.
106

117
## Inlay Hints
128

Loading
12.3 KB
Loading
149 KB
Loading
94.2 KB
Loading

assets/walkthrough/previewDocs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Preview Documentation
22
![Preview documentation](./images/previewDocumentation.gif)
33

4-
You can preview [documentation written using DocC](https://www.swift.org/documentation/docc/) directly in VS Code.
4+
You can preview [documentation written using DocC](https://www.swift.org/documentation/docc/) directly in VS Code by using the Preview Swift Documentation button at the top right of an editor, or by invoking `Swift: Preview Documentation` in the command palette in a `.docc` bundle.
55

66
Note: This feature requires Swift 6.2 or later.

assets/walkthrough/runExecutable.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
# Run Swift Executable
2-
![Run swift executable](./images/runExecutable.gif)
1+
# Run Swift Executables
2+
![Runing a swift executable](./images/runExecutable.gif)
33

4-
You can run a Swift binary target via the:
5-
1. Code lens that appears in the `.swift` file
6-
2. Project Panel in the bottom left hand corner of the sidebar
7-
3. Tasks command: You can configure the build tasks through the `launch.json` file in the `.vscode` folder for the project
4+
You can build and run a Swift binary target via the:
5+
1. `Run` or `Debug` CodeLens that appears in the `.swift` file that contains your program's entry point
6+
2. `Project Panel` in the bottom left hand corner of the sidebar under the `Targets` and `Tasks` groups
7+
3. `Tasks` command: You can configure the build tasks through the `launch.json` file in the `.vscode` folder for the project and then select the target you'd like to build with the `Tasks: Run Task` command from the `Command Pallete`
8+
4. `Run Swift executable` editor action in the top right corner of the editor
9+
![Run Swift executable](./images/runSwiftExecutable.png)
810

9-
![Debug Swift Executable](./images/debugExecutable.gif)
1011

11-
You can debug a target by setting a breakpoint and clicking the the ``Debug Swift Executable`` button on the tab bar or through the ``Run and Debug panel`` in the sidebar.
12+
# Debug Swift Executables
13+
14+
![Debuging a swift executable](./images/debugExecutable.gif)
15+
16+
The extension automatically generates the debug and release variants of launch configurations in `launch.json`. You can debug a target by setting a breakpoint and clicking the the `Debug Swift Executable` editor action or through the `Run and Debug` panel in the sidebar.

assets/walkthrough/runTests.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Run Swift Testing and XCTest Tests
22
![Run a test](./images/runTests.gif)
33

4-
XCTests and Swift Testing tests are detected automatically. You can run them by clicking the ▶ button, with the `Run Test` code lens or through the `Test Explorer` in the sidebar.
4+
Swift Testing and XCTests tests are detected automatically. You can run tests by:
5+
1. Clicking the ▶ button or right clicking ▶ button beside the line number, and selecting a test variant such as `Debug Test` or `Run with Coverage`
6+
2. Clicking `Run`, `Debug` or `Run w/ Coverage` in the CodeLens
7+
3. Using the `Test Explorer` in the sidebar

assets/walkthrough/runningTests.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)