Reviewing documentation changes currently requires checking out the branch and building the docs locally.
Set up automated preview deployments for pull requests so reviewers can view the rendered documentation before changes are merged. On each PR update, the documentation should be built and published to a GitHub Pages preview site under a PR-specific URL.
One option would be to use to use commercial software, such as Vercel, Netlify, Cloudflare, which handle some of this automatically. But I think it would be simpler (and free) to just do it with a separate git repo.
What I have in mind is the following:
- Create a separate GitHub Pages repository for documentation previews.
- On each PR update, build the docs in the
struphy repository.
- Push the generated static files to the preview repository under a PR-specific folder (e.g.
pr-123/).
- GitHub Pages publishes the preview automatically. Each preview can be found under
https://struphy-hub.github.io/docs-preview/pr-123/
- Remove the preview folder when the PR is closed with a second workflow.
Reviewing documentation changes currently requires checking out the branch and building the docs locally.
Set up automated preview deployments for pull requests so reviewers can view the rendered documentation before changes are merged. On each PR update, the documentation should be built and published to a GitHub Pages preview site under a PR-specific URL.
One option would be to use to use commercial software, such as Vercel, Netlify, Cloudflare, which handle some of this automatically. But I think it would be simpler (and free) to just do it with a separate git repo.
What I have in mind is the following:
struphyrepository.pr-123/).https://struphy-hub.github.io/docs-preview/pr-123/