make documentation more consistent between articles

Author: matthewbastien

userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md

@@ -0,0 +1,11 @@
+# Installing Pre-Release Builds
+
+Live on the bleeding edge by switching to the pre-release version.
+
+The Swift extension provides pre-release builds that can be used to test out unreleased features or get bug fixes before an official release can be published. Pre-release build numbers are always one minor version ahead of the most recent release.
+
+The "Switch to Pre-Release Version" button in the VS Code extensions view is used to install the latest pre-release builds:
+
+![](install-pre-release.png)
+
+A "Switch to Release Version" button will appear in its place that lets you go back to the official release.

userdocs/userdocs.docc/Articles/Advanced/remote-dev.md

@@ -1,6 +1,6 @@
 # Visual Studio Code Dev Containers
 
-Dev containers can be used as an easy way to develop when building for other platforms.
+Create reusable development environments using containers.
 
 [VS Code Dev Containers](https://code.visualstudio.com/docs/remote/containers) allows you to run your code and environment in a container. This is especially useful for Swift when developing on macOS and deploying to Linux. You can ensure there are no compatibility issues in Foundation when running your code. The extension also works with [GitHub Codespaces](https://github.com/features/codespaces) to allow you to write your code on the web.
 

userdocs/userdocs.docc/Articles/Features/automatic-task-creation.md

@@ -1,13 +1,13 @@
 # Automatic Task Creation
 
-vscode-swift automatically adds tasks for common operations with your Package.
+Tasks added for common operations with your Package.
 
-> Tip: Tasks use workflows common to all VSCode extensions. For more information see https://code.visualstudio.com/docs/editor/tasks
+> 💡 Tip: Tasks use workflows common to all VS Code extensions. For more information see [the VS Code documentation for tasks](https://code.visualstudio.com/docs/editor/tasks).
 
-For workspaces that contain a **Package.swift** file, this extension will add the following tasks:
+For workspaces that contain a **Package.swift** file, the Swift extension will add the following tasks:
 
 - **Build All**: Build all targets in the Package
 - **Build Debug <Executable>**: Each executable in a Package.swift get a task for building a debug build
 - **Build Release <Executable>**: Each executable in a Package.swift get a task for building a release build
 
-These tasks are available via **Terminal ▸ Run Task...** and **Terminal ▸ Run Build Task...**.
+These tasks are available via the commands **Terminal ▸ Run Task...** and **Terminal ▸ Run Build Task...** in the command palette.

userdocs/userdocs.docc/Articles/Features/debugging.md

@@ -1,11 +1,11 @@
 # Debugging
 
-vscode-swift allows you to debug your Swift packages.
+Debug your Swift executables using LLDB.
 
-> Tip: Debugging works best when using a version of the Swift toolchain 6.0 or higher
+> 💡 Tip: Debugging workflows are common to all VS Code extensions. See the [VS Code documentation about testing](https://code.visualstudio.com/docs/debugtest/testing) for a more in-depth overview.
+>
+> Debugging works best when using a version of the Swift toolchain 6.0 or higher.
 
 When you open a Swift package (a directory containing a `Package.swift` file), the extension automatically generates build tasks and launch configurations for each executable within the package. Additionally, if the package includes tests, the extension creates a configuration specifically designed to run those tests. These configurations all leverage the CodeLLDB extension as the debugger of choice.
 
 Use the **Run > Start Debugging** menu item to run an executable and start debugging. If you have multiple launch configurations you can choose which launch configuration to use in the debugger view.
-
-Debugging uses workflows common to all VSCode extensions. For more information see https://code.visualstudio.com/docs/editor/debugging

userdocs/userdocs.docc/Articles/Features/docc-live-preview.md

@@ -1,6 +1,6 @@
 # Documentation Live Preview
 
-vscode-swift shows you a live preview of your Swift documentation while editing.
+Show a live preview of your Swift documentation while editing.
 
 > Note: This feature is only available when using a Swift toolchain 6.2 or higher running on macOS or Linux.
 

userdocs/userdocs.docc/Articles/Features/language-features.md

@@ -1,5 +1,5 @@
 # Language Features
 
-vscode-swift provides various language features to help you write Swift code.
+Language features to help you write Swift code.
 
-The extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). To ensure the extension functions correctly, it’s important to first build the project so that SourceKit-LSP has access to all the symbol data. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.
+The Swift extension provides language features such as code completion and jump to definition via [SourceKit-LSP](https://github.com/apple/sourcekit-lsp). To ensure the extension functions correctly, it’s important to first build the project so that SourceKit-LSP has access to all the symbol data. Whenever you add a new dependency to your project, make sure to rebuild it so that SourceKit-LSP can update its information.

userdocs/userdocs.docc/Articles/Features/project-view.md

@@ -1,6 +1,6 @@
-# Project View
+# Swift Project View
 
-vscode-swift provides project view
+View aspects of your Swift project at a glance.
 
 If your workspace contains a package, this extension will add a **Swift Project** view to the Explorer:
 

userdocs/userdocs.docc/Articles/Features/test-coverage.md

@@ -1,9 +1,27 @@
-# Test Explorer
+# Running and Debugging Tests
 
 vscode-swift shows test results in the test explorer.
 
+> 💡 Tip: The Test Explorer UI is common to all VS Code extensions. See the [VS Code documentation about testing](https://code.visualstudio.com/docs/debugtest/testing) for a more in-depth overview.
+
 If your package contains tests then they can be viewed, run and debugged in the Test Explorer.
 
 ![](test-explorer.png)
 
 Once your project is built, the Test Explorer will list all your tests. These tests are grouped by package, then test target, and finally, by XCTestCase class. From the Test Explorer, you can initiate a test run, debug a test run, and if a file has already been opened, you can jump to the source code for a test.
+
+## Run Tests with Coverage
+
+Test coverage is a measurement of how much of your code is tested by your tests. It defines how many lines of code were actually run when you ran your tests and how many were not. When a line of code is not run by your tests it will not have been tested and perhaps you need to extend your tests.
+
+The Swift extension integrates with VS Code's Code Coverage APIs to record what code has been hit or missed by your tests.
+
+![](coverage-run.png)
+
+Once you've performed a code coverage run a coverage report will be displayed in a section of the primary side bar. This report lists all the source files in your project and what percentage of lines were hit by tests. You can click on each file to open that file in the code editor. If you close the report you can always get it back by running the command `Test: Open Coverage`.
+
+![](coverage-report.png)
+
+After generating code coverage lines numbers in covered files will be coloured red or green depending on if they ran during the test run. Hovering over the line numbers shows how many times each line was run. Hitting the "Toggle Inline Coverage" link that appears when hovering over the line numbers will keep this information visible.
+
+![](coverage-render.png)

userdocs/userdocs.docc/Articles/Features/test-explorer.md

@@ -1,56 +1,58 @@
 # Commands
 
-vscode-swift adds various commands to Visual Studio Code.
+Useful VS Code commands added by the Swift extension.
 
-The extension adds the following commands, available via the command palette.
+> 💡 Tip: Commands can be accessed from the VS Code command palette which is common to all VS Code extensions. See the [VS Code documentation about the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) for a more in-depth overview.
+
+The Swift extension adds the following commands, each prefixed with `"Swift: "` in the UI.
 
 #### Configuration
 
-- **Create New Project...**: Create a new Swift project using a template. This opens a dialog to guide you through creating a new project structure.
-- **Create New Swift File...**: Create a new `.swift` file in the current workspace.
-- **Select Toolchain**: Select the locally installed Swift toolchain (including Xcode toolchains on macOS) that you want to use Swift tools from.
+- **`Create New Project...`** - Create a new Swift project using a template. This opens a dialog to guide you through creating a new project structure.
+- **`Create New Swift File...`** - Create a new `.swift` file in the current workspace.
+- **`Select Toolchain...`** - Select the locally installed Swift toolchain (including Xcode toolchains on macOS) that you want to use Swift tools from.
 
 The following command is only available on macOS:
 
-- **Select Target Platform**: This is an experimental command that offers code completion for iOS and tvOS projects.
+- **`Select Target Platform...`** - An experimental command that offers code completion for iOS and tvOS projects.
 
 #### Building and Debugging
 
-- **Run Build**: Run `swift build` for the package associated with the open file.
-- **Debug Build**: Run `swift build` with debugging enabled for the package associated with the open file, launching the binary and attaching the debugger.
-- **Attach to Process...**: Attach the debugger to an already running process for debugging.
-- **Clean Build Folder**: Clean the build folder for the package associated with the open file, removing all previously built products.
+- **`Run Build`** - Run `swift build` for the package associated with the open file.
+- **`Debug Build`** - Run `swift build` with debugging enabled for the package associated with the open file, launching the binary and attaching the debugger.
+- **`Attach to Process...`** - Attach the debugger to an already running process for debugging.
+- **`Clean Build Folder`** - Clean the build folder for the package associated with the open file, removing all previously built products.
 
 #### Dependency Management
 
-- **Resolve Package Dependencies**: Run `swift package resolve` on packages associated with the open file.
-- **Update Package Dependencies**: Run `swift package update` on packages associated with the open file.
-- **Reset Package Dependencies**: Run `swift package reset` on packages associated with the open file.
-- **Add to Workspace**: Add the current package to the active workspace in VS Code.
-- **Clean Build**: Run `swift package clean` on packages associated with the open file.
-- **Open Package.swift**: Open `Package.swift` for the package associated with the open file.
-- **Use Local Version**: Switch the package dependency to use a local version of the package instead of the remote repository version.
-- **Edit Locally**: Make the package dependency editable locally, allowing changes to the dependency to be reflected immediately.
-- **Revert To Original Version**: Revert the package dependency to its original, unedited state after local changes have been made.
-- **View Repository**: Open the external repository of the selected Swift package in a browser.
+- **`Resolve Package Dependencies`** - Run `swift package resolve` on packages associated with the open file.
+- **`Update Package Dependencies`** - Run `swift package update` on packages associated with the open file.
+- **`Reset Package Dependencies`** - Run `swift package reset` on packages associated with the open file.
+- **`Add to Workspace`** - Add the current package to the active workspace in VS Code.
+- **`Clean Build`** - Run `swift package clean` on packages associated with the open file.
+- **`Open Package.swift`** - Open `Package.swift` for the package associated with the open file.
+- **`Use Local Version`** - Switch the package dependency to use a local version of the package instead of the remote repository version.
+- **`Edit Locally`** - Make the package dependency editable locally, allowing changes to the dependency to be reflected immediately.
+- **`Revert To Original Version`** - Revert the package dependency to its original, unedited state after local changes have been made.
+- **`View Repository`** - Open the external repository of the selected Swift package in a browser.
 
 #### Testing
 
-- **Test: Run All Tests**: Run all the tests across all test targes in the open project.
-- **Test: Rerun Last Run**: Perform the last test run again.
-- **Test: Open Coverage**: Open the last generated coverage report, if one exists.
-- **Test: Run All Tests in Parallel**: Run all tests in parallel. This action only affects XCTests. Swift-testing tests are parallel by default, and their parallelism [is controlled in code](https://developer.apple.com/documentation/testing/parallelization).
+- **`Test: Run All Tests`** - Run all the tests across all test targes in the open project.
+- **`Test: Rerun Last Run`** - Perform the last test run again.
+- **`Test: Open Coverage`** - Open the last generated coverage report, if one exists.
+- **`Test: Run All Tests in Parallel`** - Run all tests in parallel. This action only affects XCTests. Swift-testing tests are parallel by default, and their parallelism [is controlled in code](https://developer.apple.com/documentation/testing/parallelization).
 
 #### Snippets and Scripts
 
-- **Insert Function Comment**: Insert a standard comment block for documenting a Swift function in the current file.
-- **Run Swift Script**: Run the currently open file, as a Swift script. The file must not be part of a build target. If the file has not been saved it will save it to a temporary file so it can be run.
-- **Run Swift Snippet**: If the currently open file is a Swift snippet then run it.
-- **Debug Swift Snippet**: If the currently open file is a Swift snippet then debug it.
+- **`Insert Function Comment`** - Insert a standard comment block for documenting a Swift function in the current file.
+- **`Run Swift Script`** - Run the currently open file, as a Swift script. The file must not be part of a build target. If the file has not been saved it will save it to a temporary file so it can be run.
+- **`Run Swift Snippet`** - If the currently open file is a Swift snippet then run it.
+- **`Debug Swift Snippet`** - If the currently open file is a Swift snippet then debug it.
 
 #### Diagnostics
 
-- **Capture VS Code Swift Diagnostic Bundle**: Capture a diagnostic bundle from VS Code, containing logs and information to aid in troubleshooting Swift-related issues.
-- **Clear Diagnostics Collection**: Clear all collected diagnostics in the current workspace to start fresh.
-- **Restart LSP Server**: Restart the Swift Language Server Protocol (LSP) server for the current workspace.
-- **Re-Index Project**: Force a re-index of the project to refresh code completion and symbol navigation support.
+- **`Capture Diagnostic Bundle`** - Capture a diagnostic bundle from VS Code, containing logs and information to aid in troubleshooting Swift-related issues.
+- **`Clear Diagnostics Collection`** - Clear all collected diagnostics in the current workspace to start fresh.
+- **`Restart LSP Server`** - Restart the Swift Language Server Protocol (LSP) server for the current workspace.
+- **`Re-Index Project`** - Force a re-index of the project to refresh code completion and symbol navigation support.

userdocs/userdocs.docc/Articles/Reference/commands.md

@@ -2,7 +2,9 @@
 
 vscode-swift provides various settings to configure its behaviour.
 
-The Visual Studio Code Swift extension comes with a number of settings you can use to control how it works. Detailed descriptions of each setting is provided in the extension settings page.
+> 💡 Tip: The Settings UI is common to all VS Code extensions. See the [VS Code documentation about personalizing VS Code](https://code.visualstudio.com/docs/getstarted/personalize-vscode) for a more in-depth overview.
+
+The Swift extension comes with a number of settings you can use to control how it works. Detailed descriptions of each setting are provided in the extension settings page.
 
 This document outlines useful configuration options not covered by the settings descriptions in the extension settings page.
 
@@ -65,13 +67,15 @@ Alternatively you can specfiy which specific command the arguments should apply
 
 ## SourceKit-LSP
 
-[SourceKit-LSP](https://github.com/apple/sourcekit-lsp) is the language server used by the the Swift extension to provide symbol completion, jump to definition etc. It is developed by Apple to provide Swift and C language support for any editor that supports the Language Server Protocol.
+[SourceKit-LSP](https://github.com/apple/sourcekit-lsp) is the language server used by the the Swift extension to provide symbol completion, jump to definition, etc. It is developed by Apple to provide Swift and C language support for any editor that supports the Language Server Protocol.
 
 ### Background Indexing
 
-If you're using a nightly (`main`) or recent `6.0` toolchain you can enable support for background indexing in Sourcekit-LSP. This removes the need to do a build before getting code completion and diagnostics.
+Background Indexing was added as an experimental feature in Swift toolchain version 6.0 and then enabled by default in 6.1. This feature removes the need to do a build before getting code completion and diagnostics.
+
+On startup, SourceKit-LSP will read your project information from your `Package.swift` and begin indexing your project automatically. All indexing results are cached in the `.build/index-build` folder within your workspace.
 
-To enable support, set the [`swift.sourcekit-lsp.backgroundIndexing`](vscode://settings/swift.sourcekit-lsp.backgroundIndexing) setting to `true`.
+To enable or disable this feature you can use the [`swift.sourcekit-lsp.backgroundIndexing`](vscode://settings/swift.sourcekit-lsp.backgroundIndexing) setting.
 
 ### Support for 'Expand Macro'
 

userdocs/userdocs.docc/Articles/Reference/settings.md

@@ -1,6 +1,6 @@
 # Installation
 
-vscode-code Swift is installed through the extension marketplace.
+Install the Swift extension via the VS Code Marketplace.
 
 The Swift extension is supported on macOS, Linux, and Windows.