You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As an Autonity docs site user I want to access versions of documentation for current and previous releases of the Autonity software So that I can read documentation for the Autonity software version I am using.
It is worth clarifying what version we want to display in the version dropdown. We should keep it simple and use a single version identifier, and I suggest it would be more appropriate to go with the "protocol version" (currently named after rivers).
Latest (shows the current stable release docs. At the moment, Thames, driven from master branch`)
Develop (shows the development branch, a preview of the next release under dev, driven from develop branch)
Protocol Version name - e.g. Thames. The current stable release. At the moment, Thames. Older versions have the previous release name and are ordered by time.
Publishing it, we can publish from docs repo {release | tag} perhaps. This was done for previous docs sites in MK Docs (by @cmjc and @Klazomenai ).
In the scenario where a new client version is released but it's the same protocol version (e.g. a minor change, e.g. adding a new command line option):
Add bullet point to the release as above on the Reference Codebase page to say Docs updated for new client version XYZ (x.y.z).
Highlight in the docs where a change has been made for this new version. For example, create a custom Shortcode or use a Note or a Card
As an Autonity docs site user
I want to access versions of documentation for current and previous releases of the Autonity software
So that I can read documentation for the Autonity software version I am using.
Tasks:
References
The text was updated successfully, but these errors were encountered: