As it stands right now, whenever a new pull request is created, the github pages site is automatically overwritten and deployed using the content of the pull request. This is a big problem because:
If someone doesn't follow the formatting in their PR or makes a mistake, these things will be caught in review, and obviously the docs pages shouldn't be rebuilt until the issues are fixed
We will be constantly creating new deployments of the doc pages anytime a new push is sent to a branch which has a PR on it
It is poor practice
In order to address this, ideally the workflow would look like this:
When someone creates a PR, their docs can be previewed and reviewed at some development path on the pages site (Espeer5/github.io/PREVIEWS/PR#...)
When a PR is approved and merged into main, the doc pages are rebuilt and deployed to the actual docs site.
As it stands right now, whenever a new pull request is created, the github pages site is automatically overwritten and deployed using the content of the pull request. This is a big problem because:
In order to address this, ideally the workflow would look like this: