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

Host Documentation on Swift Package Index #22

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

Conversation

DandyLyons
Copy link

@DandyLyons DandyLyons commented Sep 12, 2024

I've added a simple SPI manifest so that SPI can build and host the DocC documentation. For context see: https://swiftpackageindex.com/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest/commonusecases#spiHosting

Room For Further Improvement

This PR only adds SPI doc hosting. It makes no changes to the DocC itself.

Currently, this DocC documentation does not include articles like the contents of the Documentation directory, including the Getting Started.md.

It would be valuable to include that in the DocC as well. I can do that in a future commit if you like. I just wanted to confirm the structure of how you all would like to do it.

After SPI builds and hosts the documentation, it would be good to add that URL to the README, to make it easier to find.

Checklist

  • I've read the Contribution Guidelines
  • My contributions are licensed under the Swift license.
  • I've followed the coding style of the rest of the project.
  • I've added tests covering my changes (if appropriate).
  • I've verified that my change compiles and works correctly, and does not break any existing tests.
  • I've updated the documentation (if appropriate).

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.

1 participant