Doc: meta-issue: update Alpha doc entry when creating a new environment
This meta-issue is a guideline for updating the doc when creating a new environment V<N>
.
Do not close it, please, ever.
The places in the doc that need to be updated are not listed here. Instead, a TODO
tag pointing to the present issue are placed in each RST file to be changed. The long description of the tag may mention more specific instructions for the particular updates in that file, or around that point.
For instance, the validation entry of protocol Alpha has a hardcoded reference to its proto-environment, and its API. To mark the necessary change, file alpha/validation.rst
contains a TODO tag pointing the current issue.
Concretely, proceed as follows to update the doc when creating a new environment:
- look for the string "#4155" in the RST files under
docs/
- for each occurence in the doc for Alpha and outside the protocols doc, update references to the old environment
V<N-1>
, unless the local instructions in the tag tells you to do something more specific. - for each occurence in the doc for other protocols: do nothing, as the environment for these protocols is frozen (you could even remove the TODO tag altogether, after checking that the environment is at the right version for that protocol).
Edited by Nic Volanschi