docs: Link to latest release documentation on Swift Package Index #124
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
euanh
added
area/documentation
euanh
force-pushed
the
docs/link-to-latest-release
branch
from
8d21ecf to
f29da3f
Compare
euanh
force-pushed
the
docs/link-to-latest-release
branch
from
f29da3f to
1a4797b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
By default, Swift Package Index shows the documentation for the latest release. In release 1.0.0,
containertoolwas still the first target in.spi.yml, which caused the left-hand navigation bar (the curation) to show the topics forcontainertooleven though the main content is the Swift Container Plugin Documentation.As a temporary work-around, #112 changed links from README.md to point to SPI's documentation for the
mainbranch. This caused the updated.spi.ymlto be used and the correct curation to be shown, but also meant that unreleased features could not be documented because the live documentation would diverge from what had been released.Version 1.0.1 has now been released, with some refactoring and documentation changes. Links in
README.mdcan now safely refer to the most recent release again.Fixes #113, reverts changes in #112.
Modifications
README.mdlead to documentation describing the most recent release, not the live state ofmain.Result
mainwithout the risk of confusing users looking for documentation for the latest release.Test Plan
No functional change. Links checked manually.