Code Releases

Frontity keeps the docs updated with the latest features released in the source code.

This is the community discussion regarging this topic: Code <-> Documentation workflow

For every new feature, bug fixing or code update that requires a change in the docs, this is the workflow to follow on both the code repository (code PR) and the docs repostitory (docs PR):

From the code repository side (code PR)

As part of the developer's work, every time a code PR is opened:

• An additional Pull Request in the docs repository (docs PR) should be opened
• Once the docs PR is opened, link to it in the code PR
• The code PR shouldn't be merged until the docs PR is fully approved and merged

Example:

• Code PR: https://github.com/frontity/frontity/pull/420
• Related Docs PR: https://github.com/frontity/gitbook-docs/pull/60

From the docs repository side (docs PR)

These docs PR associated to code PR cannot be merged until the release of the code is done.

The docs PR should be done against a specific branch (named code) whose only purpose is to store code changes

The docs PR can be merged (into code) once the PR has been approved.

The code branch will be manually merged each time a release is done.