Documentation for Toggles is provided using DocC and is made available via GitHub Pages at the following address:
https://albertodebortoli.github.io/Toggles/documentation/toggles/
Generation is done using the Swift-DocC plugin by running the following command that will regenerate the content of the docs
folder:
swift package --allow-writing-to-directory docs \
generate-documentation --target Toggles \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path Toggles \
--output-path docs
The branch used for GitHub Pages is DocC that should be kept up-to-date with main.
Since DocC doesn't allow versioning the documentation, it's ok to:
- rebase on top of main
- regenerate the documentation
- force push the changes