๐ @community
GitHub Community
How to provide online access to source documentation upon release. #200322
Answered
by
Carloscavalcante3
Fran-B
asked this question in
Repositories
ยท
4 comments
ยท
1 reply
Answered by
Carloscavalcante3
Exactly, GitHub Pages has two publishing methods:
- From a branch (traditionally gh-pages), where the generated HTML files are stored in that branch.
- From a GitHub Actions workflow, where the documentation is generated during the workflow and then deployed directly to GitHub Pages. With this approach, you don't have to maintain a gh-pages branch yourselfโthe workflow builds the documentation and publishes it for you.
Since you're new to GitHub, I'd actually recommend starting with the first option because it's easier to understand. Once you're comfortable with GitHub Actions, you can automate the entire process.
And yes, you can absolutely make this part of your release process. For exampโฆ
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Category
Repositories
