Tie docs to releases

[dbanty]

Right now, docs deploy on every push to main. Sometimes this is a good thing (fixing typos, etc.), but sometimes the new docs refer to new features which may not be released yet. I can see two possible paths forward:

1. Have a development branch which is not main, it would be next or something. Code changes target that branch, the release preview PR comes from that branch and goes to main. Merging that particular branch should be done with rebase (where all others are squash), which could be messy to maintain. Also, contributors need to know where to point their contributions based on the type.
2. Stop auto-deploying docs changes from main, make it part of the release workflow. This isn't great because minor docs contributions won't roll out until a new version of Knope is released, and there might not be a new version of Knope to release in all cases. We could also make this workflow-dispatch so that docs builds can be manually triggered sometimes?

Surely there must be a good solution to this problem used by other projects which we can just adopt.

[ghost]

I propose a third idea.
what if there was a branch exclusively dedicated to documentation releases? let's call it documentation.

main could still be the default branch, but every time you gotta update the documentation, you rebase the documentation branch on main (or merge into it, but i like rebasing for this case). This way documentation is no longer tied to the default branch.

This does add an extra step, but knope should be able to easily handle this workflow ^^

[dbanty]

That's a good idea, then the default workflow of bundling upcoming changes together works well (especially if we automate that rebase onto documentation), but if there's a docs-only change to release in the meantime that PR could be merged straight into documentation so it doesn't have to wait for a release.