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

Enable Swift Package Index documentation and add API doc link #149

Merged
merged 2 commits into from
Feb 2, 2024

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Jan 22, 2024

Bug/issue #, if applicable: None

Summary

  1. Add .spi.yml file to make SwiftPackageIndex build documentation for this package.
  2. Update README.md to add a link pointing to the corresponding link. (The link will be available on the next day after the PR is merged. SPI's CI is triggered with a 24h window.)

See https://github.com/apple/swift-algorithms/blob/main/.spi.yml

Dependencies

None

Testing

None

Checklist

  • Ran the swift test and it succeeded
  • Updated documentation if necessary

Future work

After this PR, we'll only get the basic docc documentation support.

  • Add SystemPackage.docc in Sources/System to adjust the doc page.

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jan 22, 2024

@swift-ci please test

.spi.yml Outdated Show resolved Hide resolved
Co-authored-by: Max Desiatov <m_desiatov@apple.com>
@Kyle-Ye Kyle-Ye requested a review from MaxDesiatov January 22, 2024 09:23
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jan 22, 2024

@swift-ci please test

@MaxDesiatov
Copy link
Member

@Kyle-Ye would you kindly update the description providing more context and motivation for the change? Thanks!

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jan 22, 2024

@Kyle-Ye would you kindly update the description providing more context and motivation for the change? Thanks!

Done. (There is no PR template in this repo so I forgot to add description here. Sorry for that. And I use the template in swift-docc to fill it in the end.)

Do you think we should address the "Future work" part in this PR?

@MaxDesiatov
Copy link
Member

IMO no need to get the PR bigger than it is now, let's wait for feedback from maintainers first.

@glessard glessard changed the title Enable SPI documentation and add API doc link Enable Swift Package Index documentation and add API doc link Jan 22, 2024
@glessard glessard merged commit 51f6be0 into apple:main Feb 2, 2024
2 checks passed
@Kyle-Ye Kyle-Ye deleted the optimize/doc branch February 3, 2024 04:22
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