We need to keep the docs up to date with code changes. We are already including tasks for the documentation in our PRs, but they need to be done in a separate repo:
gitbook-docs. For that reason, I think we need to agree on a common workflow between the devrel and dev teams.
First, it seems like right now, the dev-team is still using the GitBook UI interface to do the changes: https://github.com/frontity/frontity/pull/382
If I’m not mistaken, the devrel-team would prefer to switch to PRs in the
gitbook-docs repo. Could you please confirm that?
If we switch to PRs, my idea is to:
- Still include the documentation task in our PRs.
- As part of the PR work, open an additional PR in the
- Once that PR is opened, link to it and check the task as done.
It doesn’t make sense to me to “review” the docs twice, as soon as there is a PR open in the
gitbook-docs repo, the task of the original PR is checked and we can merge it.
The conversation and review of the docs are finished in the
Here you have an example of a PR with a linked documentation task and the new PR:
Finally, there’s an extra thing to discuss: How to deal with documentation in external collaborations. But as I saw that our own workflow is not clear yet, let’s first agree on that and we can decide what to do with external collaboration later.