court-dashboard icon indicating copy to clipboard operation
court-dashboard copied to clipboard

Integrate documentation updates into the product release workflow

Open john-light opened this issue 4 years ago • 4 comments

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

john-light avatar Apr 21 '20 17:04 john-light