Code Releases

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

This is the community discussion regarding 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 Issue):

• On every code PR that require documentation, the developer in charge should create and issue in the docs repository with the following info:

  • Related code PR link
  • Related community forum posts or feature discussions links
  • Any other info that can help in the documentation task
  • Labels
    • priority: 2 high → This should be the default priority but the developer can assign another one from the ones available. The DevRel team will take this priority into account but will decide the final priority for the task
    • code-release → This label will help the DevRel team to discriminate those issues generated from a code PR
    • any other label that can help to understand better the scope of the issue (max 2 more labels). Example: packages, core

• Once the docs issue is created the developer should add the link to that issue on the code PR

Every time an issue is created, a quick notification to the DevRel team (via quick message in the #documentation channel) would be appreciated
The DevRel will review these tasks, prioritize them, and work on some of them on every sprint.

Documentation changes before code releases

• To simplify the process we'll work directly against the master branch and no documentation task will be merged until the related feature has been released