You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Point to main branch documentation on Swift Package Index (apple#112)
Motivation
----------
By default, Swift Package Index shows the documentation for the latest
release. This still has the `containertool` documentation target in
`.spi.yml`, which is causing the left-hand navigation bar (the curation)
to show the topics for `containertool` even though the main content is
the Swift Container Plugin Documentation.
This should be resolved when the next release is tagged, but in the
meantime linking to the `main` branch documentation will cause users to
see the most up-to-date documentation with the correct navigation bar.
Modifications
-------------
Links to the SPI documentation in `README.md` point to the `main`
branch.
Result
------
Users should see the latest documentation, with the correct navigation
bar.
Test Plan
---------
No functional change.
All existing tests continue to pass.
@@ -69,6 +69,6 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904
69
69
70
70
## Getting Started
71
71
72
-
Learn more about setting up your project in the [plugin documentation](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/swift-container-plugin).
72
+
Learn more about setting up your project in the [plugin documentation](https://swiftpackageindex.com/apple/swift-container-plugin/main/documentation/swift-container-plugin).
Copy file name to clipboardExpand all lines: Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ To use the plugin:
29
29
### Build and publish a container image
30
30
31
31
After adding the plugin to your project, you can build and publish a container image in one step.
32
-
Here is how to build the [HelloWorld example](https://github.com/apple/swift-container-plugin/tree/main/Examples/HelloWorldHummingbird) as a static executable for Linux running the `x86_64` architecture:
32
+
Here is how to build the [HelloWorld example](https://github.com/apple/swift-container-plugin/tree/main/Examples/HelloWorldHummingbird) as a static executable for Linux running on the `x86_64` architecture:
33
33
34
34
```
35
35
% swift package --swift-sdk x86_64-swift-linux-musl \
0 commit comments