Integrate documentation updates into the product release workflow

[john-light]

I noticed that the dashboard has updated some of the terminology used. For example, the voting options changed to "Allow action" and "Block action", replacing the old terminology "In favor" and "Against". Additionally "Evidence" is now called "Arguments".

However, there has been no pull request or issue created in the help repo to update these terms in the documentation, and in general documentation has not been kept in the loop for Court dashboard product releases.

I would like to propose that documentation updates be included as a mandatory checklist item to be completed before the dashboard is updated on mainnet so that the documentation is always kept up to date with new releases.

To update the documentation the following information is needed for each pending release:

• A complete list of changes, including bug fixes and new features
• Any new screenshots to replace out of date screenshots

[sohkai]

I would like to propose that documentation updates be included as a mandatory checklist item to be completed before the dashboard is updated on mainnet so that the documentation is always kept up to date with new releases.

This would be difficult to do as we publish new versions on every merge, but we should certainly flag when we need a documentation upgrade (either because there's a visual, copy, or feature change).

cc @fabriziovigevani @rperez89 I think this is really on the creator of the pull request to do—perhaps we can use a "documentation update" label to flag these types of pull requests?

[fabriziovigevani]

perhaps we can use a "documentation update" label to flag these types of pull requests?

Yes let's do that.

[john-light]

Thanks!

To make it easy to update screenshots as needed, is there a "controlled environment" I can use to create disputes and trigger other actions "at will" so I can get the exact shot I need for a given section of documentation?

[sohkai]

Unfortunately the mocking set up we have is not readily available at the moment for non-devs to configure.

When we change interfaces, we will have to work with you on obtaining these screenshots for now.