Add docc support and publish documentation to GitHub pages #137
Conversation
Kyle-Ye
commented
Apr 3, 2022
Kyle-Ye
commented
- Move Guides into swift-docc based format
- Publish documentation to Github pages
There was a problem hiding this comment.
@parkera and I discussed earlier about how this does mean that we are publishing docs before stuff is completely settled per reviews - as long as we generate stuff at given sub-major milestones before 1.0 I think that should be fine as per documentation.
|
|
||
| # Use git worktree to checkout the gh-pages branch of this repository in a gh-pages sub-directory | ||
| git fetch | ||
| git worktree add --checkout gh-pages origin/gh-pages |
There was a problem hiding this comment.
to lands this we will need to make a blank branch gh-pages as well as do the remaining setup for that
There was a problem hiding this comment.
Yes, we need a gh-pages branch and add the environment GitHub action.
|
Fixed the CR suggestion and rebased main to solve the conflicts. |
There was a problem hiding this comment.
So ive been coordinating with some other folks to get the remainder of the back-end tasks finished for this. There are some additional tasks we will need before it will all be ready to publish;
- we need a redirect similar to how swift-argument-parser did it (however perhaps it might be good to stash that redirect.html in say a
lib/directory. - some of the sub-titles are kinda wonky for the guides being imported as articles some minor restructuring will be needed for those.
- I think there are some general enhancements we can do for the documentation to show methods as extensions to
AsyncSequence(I have some ideas here we can explore)
none of those are to say blockers for getting this first step done; we can split it up into a couple of issues so we can get it done together.
|
here is what it looks like currently: https://phausler.github.io/swift-async-algorithms/documentation/asyncalgorithms/ |
