Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change doc references #532

Merged
merged 6 commits into from
Jan 9, 2023
Merged

Change doc references #532

merged 6 commits into from
Jan 9, 2023

Conversation

yim-lee
Copy link
Member

@yim-lee yim-lee commented Dec 4, 2022

Together with #531, updating GitHub pages references to those hosted by Swift Package Index.

Together with apple#531, updating GitHub pages references to those hosted by Swift Package Index.
@yim-lee
Copy link
Member Author

yim-lee commented Dec 4, 2022

@rauhul This PR addresses your comment in #531

@rauhul
Copy link
Contributor

rauhul commented Dec 9, 2022

LGTM, but @natecook1000 should probably verify that there's no other doc generation tools which include this string

@natecook1000
Copy link
Member

@yim-lee Thanks for this! I've been keeping the docs parallel to the latest release, instead of the main branch. Does SPI support that approach?

Copy link
Member

@natecook1000 natecook1000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I see — release support is there, but SPI didn't build those docs because we added the .spi.yml file after 1.2.0 was released. That should be resolved when we do a 1.2.1 release, so I'll merge this change as part of that process.

In the meantime, let's drop the main/ from the URLs so that SPI automatically forwards to the latest release. (You can see this behavior with swift-atomics here: https://swiftpackageindex.com/apple/swift-atomics/documentation/atomics)

CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
yim-lee and others added 4 commits December 9, 2022 09:54
Co-authored-by: Nate Cook <natecook@apple.com>
Co-authored-by: Nate Cook <natecook@apple.com>
Co-authored-by: Nate Cook <natecook@apple.com>
@natecook1000
Copy link
Member

@swift-ci Please test

@natecook1000 natecook1000 merged commit 255ef66 into apple:main Jan 9, 2023
@yim-lee yim-lee deleted the patch-2 branch January 9, 2023 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants