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

[install] Add Swiftly to the install page under beta/preview #830

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shahmishal
Copy link
Member

Bring swiftly to swift.org install page under beta/preview.

Linux

Screenshot 2024-10-18 at 12 17 55 AM

macOS

Screenshot 2024-10-18 at 12 17 43 AM

@ktoso
Copy link
Contributor

ktoso commented Oct 18, 2024

🎉 🎉 🎉

Excited to see this :-)

Copy link
Member

@0xTim 0xTim left a comment

Choose a reason for hiding this comment

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

🥳

@@ -0,0 +1,48 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

question: Should we use the getting started guide that's in the swiftly documentation set here?

There is already a getting started guide for swiftly written in DocC. You can see its current state published here on SPI:

https://swiftpackageindex.com/swiftlang/swiftly/main/documentation/swiftlydocs/getting-started

It's not aligned with these swift.org website changes yet, but we can get PR's merged to fully align them.

Option 1: Link the detailed swiftly documentation to the SPI site. Use the release branch so that the documentation aligns with what the user will download from swift.org.

Option 2: Take the published DocC HTML from the GitHub action on the swiftly repo and publish it to the swift.org website here. When we run the release workflow it publishes the Linux x86_64 tar.gz, and also the DocC content.

Option 3: Use a CI job to do the same as option 2, just running the docc plugin as the GH workflow does today.

@flexlixrup
Copy link

@shahmishal What's the state of the PR? Swiftly already merged their PR two weeks ago so Swiftly is technically unavailable when following the install guide.

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.

5 participants