VOOZH about

URL: https://github.com/orgs/community/discussions/200322

โ‡ฑ How to provide online access to source documentation upon release. ยท community ยท Discussion #200322 ยท GitHub


Skip to content

๐Ÿ‘ @community
GitHub Community

How to provide online access to source documentation upon release. #200322

Exactly, GitHub Pages has two publishing methods:

  1. From a branch (traditionally gh-pages), where the generated HTML files are stored in that branch.
  2. 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โ€ฆ

Replies: 4 comments ยท 1 reply

๐Ÿ‘ Image
Carloscavalcante3

0 replies

๐Ÿ‘ Image
Fran-B
Author

0 replies

๐Ÿ‘ Image
Carloscavalcante3

1 reply
Answer selected by Fran-B

๐Ÿ‘ Image
jeman-arcanist

0 replies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You canโ€™t perform that action at this time.