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

Add .spi.yml for Swift Package Index docs #1059

Merged
merged 2 commits into from
Jun 22, 2023
Merged

Conversation

scannillo
Copy link
Contributor

Summary

Braintree iOS is currently accessible via the Swift Package Index (https://swiftpackageindex.com/braintree/braintree_ios). This PR enhances our Swift Package Index experience by supporting it's auto-hosting DocC feature.

Changes

  • Add a .spi.yml file
    • See SPI docs on how this auto-hosted, auto-generated docs works. It's really neat! We could even have this replace our hosted reference docs entirely 👀.

Result

Once merged into master our SPI landing site will add this button:
Screenshot 2023-06-16 at 10 45 42 AM

The hosted docs & new button won't be visible until merged.

Checklist

  • Added a changelog entry

Authors

@scannillo

@scannillo scannillo requested a review from a team as a code owner June 16, 2023 15:51
@scannillo
Copy link
Contributor Author

scannillo commented Jun 16, 2023

There seems to be a limitation with DocC supporting SDKs with multiple target frameworks (see Issue - swiftlang/swift-docc#255). That issue also links a Swift Forums discussion on the topic.

I don't mind merging, seeing how SPI handles this, and then reverting if its borked.

.spi.yml Outdated Show resolved Hide resolved
@scannillo scannillo merged commit c173a59 into master Jun 22, 2023
@scannillo scannillo deleted the swift-package-index-docc branch June 22, 2023 20:30
@adam-rocska
Copy link

@scannillo did it work? Just saw your comment it’ll get reverted if it doesn’t work, and kept if it works ¯\(ツ)

@scannillo
Copy link
Contributor Author

Hi @adam-rocska, this did indeed work! You can navigate here (https://swiftpackageindex.com/braintree/braintree_ios) and click Documentation to see the docs that SPI is building on our behalf.

We would love feedback as well to your experience using those docs versus our self-hosted reference docs.

@adam-rocska
Copy link

@scannillo Hl s*t! THANKS! ❤️

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