Skip to content

Commit 48aaaeb

Browse files
committed
docs: Address CI docs checker warnings about heading levels
1 parent 8a91eb0 commit 48aaaeb

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

Sources/swift-container-plugin/Documentation.docc/Adding-the-plugin-to-your-project.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
Make Swift Container Plugin available in your project
44

5+
## Overview
6+
57
Swift Container Plugin is distributed as a Swift Package Manager package. To make it available, you must add it as a dependency of your project.
68

7-
## Install the plugin using the `swift package` CLI
9+
### Install the plugin using the `swift package` CLI
810

911
Recent versions of `swift package` suupport the `add-dependency` command:
1012

1113
```shell
1214
swift package add-dependency https://github.com/apple/swift-container-plugin --from 0.5.0
1315
```
1416

15-
## Install the plugin by manually editing `Package.swift`
17+
### Install the plugin by manually editing `Package.swift`
1618

1719
If you cannot use the `swift package add-dependency` comand, append the following lines to your project's `Package.swift` file:
1820

@@ -22,7 +24,7 @@ package.dependencies += [
2224
]
2325
```
2426

25-
## Check that the plugin is available
27+
### Check that the plugin is available
2628

2729
After installation, Swift Package Manager should show that the `ContainerImageBuilder` is now available:
2830

Sources/swift-container-plugin/Documentation.docc/Platforms-and-requirements.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

Sources/swift-container-plugin/Documentation.docc/requirements.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22

33
The open source Swift toolchain and a compatible Swift SDK make it possible to build Linux executables on macOS
44

5+
## Overview
6+
57
* Swift Container Plugin runs on macOS and Linux and requires Swift 6.0 or later.
68
* On macOS you must install a cross-compilation Swift SDK, such as the [Swift Static Linux SDK](https://www.swift.org/documentation/articles/static-linux-getting-started.html), in order to build executables which can run on Linux-based cloud infrastructure.
79
* The Swift Static Linux SDK requires the [open source Swift toolchain](https://www.swift.org/install/macos/) to be installed.
810
* A container runtime is not required to build an image, but you will need one wherever you want to run the image.
911

10-
## Install the open source Swift toolchain
12+
### Install the open source Swift toolchain
1113

1214
Follow the instructions at [https://www.swift.org/install/macos/](https://www.swift.org/install/macos/) to install the open source Swift toolchain. The easiest way to do this is to use the [Swiftly swift toolchain installer](https://www.swift.org/install/macos/swiftly/).
1315

14-
## Install a Swift SDK for cross-compilation
16+
### Install a Swift SDK for cross-compilation
1517

1618
If you are running on macOS, you can use a [Swift SDK](https://github.com/apple/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md) to cross-compile your server executable for Linux. Either:
1719

0 commit comments

Comments
 (0)