GitHub can build gh-pages branch using the contents of another branch, usually the main branch:
https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch
Right now, if I want to update non-README documentation after working on a new feature, I'll have to switch over to gh-pages and update the docs and then two pull requests will need to be made -- one for the code implementation in the feature and the other to update the docs. I don't see other Markdown files in the current main branch aside from https://github.com/ioos/glider-dac/blob/main/README.md and it looks like most of the documentation updates have been happening on the gh-pages branch.
For me when developing new features, having the feature side by side in an editor window is a big advantage when generating documentation. There are workarounds that can be done like Git worktrees, but they still suffer from the disadvantages of possibly needing two PRs for feature implementation and docs when functionality is added to the project. Therefore, I recommend moving the non-generated documentation assets to the main branch and configuring the static site generation capabilities of GitHub to use the main branch but output generated HTML, etc. to the gh-pages branch as usual.
GitHub can build
gh-pagesbranch using the contents of another branch, usually themainbranch:https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch
Right now, if I want to update non-README documentation after working on a new feature, I'll have to switch over to
gh-pagesand update the docs and then two pull requests will need to be made -- one for the code implementation in the feature and the other to update the docs. I don't see other Markdown files in the currentmainbranch aside from https://github.com/ioos/glider-dac/blob/main/README.md and it looks like most of the documentation updates have been happening on thegh-pagesbranch.For me when developing new features, having the feature side by side in an editor window is a big advantage when generating documentation. There are workarounds that can be done like Git worktrees, but they still suffer from the disadvantages of possibly needing two PRs for feature implementation and docs when functionality is added to the project. Therefore, I recommend moving the non-generated documentation assets to the
mainbranch and configuring the static site generation capabilities of GitHub to use themainbranch but output generated HTML, etc. to thegh-pagesbranch as usual.