chore: Use Swift Package Index for how to install and documentation - #87
chore: Use Swift Package Index for how to install and documentation#87chenyuan99 wants to merge 1 commit into
Conversation
kou
changed the title
There was a problem hiding this comment.
Hi Kou, it is needed as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation
There was a problem hiding this comment.
Does it mean that we need these configurations to generate documentation on Swift Package Index and we can't refer generated documentation after our next release?
If so, could you split the "adding support for documentation generation on Swift Package Index" changes and the "update README" changes to separated PRs?
We'll work on the former BEFORE we release a new version and work on the later changes AFTER we release a new version.
There was a problem hiding this comment.
Hi Kou, it is needed as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation
| ## Install | ||
|
|
||
| TODO: We should update this after we register this package to Swift Package Index. | ||
| [](https://swiftpackageindex.com/apache/arrow-swift) |
There was a problem hiding this comment.
It seems that this badge URL is 404: https://swiftpackageindex.com/apache/arrow-swift/badge.swift
Could you check it?
There was a problem hiding this comment.
these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation
| TODO: We should update this after we register this package to Swift Package Index. | ||
| [](https://swiftpackageindex.com/apache/arrow-swift) | ||
|
|
||
| You can add Apache Arrow Swift to your project using Swift Package Manager. For complete installation instructions and version selection, see the [Swift Package Index page](https://swiftpackageindex.com/apache/arrow-swift/). |
There was a problem hiding this comment.
It seems that https://swiftpackageindex.com/apache/arrow-swift/ doesn't include "complete installation instructions". Should we write them by ourselves?
There was a problem hiding this comment.
these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation
| ## Getting Started | ||
|
|
||
| TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index. | ||
| You can browse API documentation and usage examples at our [Swift Package Index documentation page](https://swiftpackageindex.com/apache/arrow-swift/documentation). Once added, import Arrow in your code and get started! |
There was a problem hiding this comment.
It seems that https://swiftpackageindex.com/apache/arrow-swift/documentation doesn't exist. Could you check it?
There was a problem hiding this comment.
these will be generated as described in https://swiftpackageindex.com/blog/auto-generating-auto-hosting-and-auto-updating-docc-documentation
|
|
||
|
|
2 participants
What's Changed
We can refer Swift Package Index because we've released a new version and registered to Swift Package Index.
Closes #86.