docs: Point to main branch documentation on Swift Package Index #112
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
added a commit
to euanh/swift-container-plugin
that referenced
this pull request
May 1, 2025
…e#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.
euanh
added a commit
that referenced
this pull request
May 1, 2025
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.
euanh
added a commit
that referenced
this pull request
May 1, 2025
Motivation ---------- By default, Swift Package Index shows the documentation for the latest release. In release 1.0.0, `containertool` was still the first target in `.spi.yml`, which caused the left-hand navigation bar (the curation) to show the topics for `containertool` even 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 `main` branch. This caused the updated `.spi.yml` to 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.md` can now safely refer to the most recent release again. Fixes #113, reverts changes in #112. Modifications ------------- * Links from `README.md` lead to documentation describing the most recent release, not the live state of `main`. Result ------ * Users will see the documentation for the latest release, with the correct curation panel. * Unreleased features can be documented on `main` without the risk of confusing users looking for documentation for the latest release. Test Plan --------- No functional change. Links checked manually.
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. This still has the
containertooldocumentation target in.spi.yml, which is causing the left-hand navigation bar (the curation) to show the topics forcontainertooleven 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
mainbranch 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.mdpoint to themainbranch.Result
Users should see the latest documentation, with the correct navigation bar.
Test Plan
No functional change.
All existing tests continue to pass.