Documentation for Concent Settlement Algorithm #1109
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #996.
This is the final version of the implementation docs for the settlement algorithm. The content is identical to #996 and to the draft at Google Docs: https://docs.google.com/document/d/12eisUDBGUuAvlGErVaUXtRmBybIB89ZLdlP5IgDn43o. There might be slight formatting differences due to different formats (document vs markdown vs reStructuredText). When this pull request is merged the blueprint and the draft will be made read-only/closed and will no longer be updated.
To build and view the rendered version:
cd docs pip install -r requirements.txt make html xdg-open build/html/index.html
Since everybody has already read the draft, this pull request should not require an in-depth review but feel free to report any formatting errors or discrepancies between the docs and the code that have not been spotted earlier.
NOTE: The main file is
docs/source/settlement-algorithm.rst
and that's the one you should focus on. There rest are diagrams. The XML files can be opened with draw.io. SVG files are a direct export from the corresponding XML files. I'd prefer not to have them in the repo but unfortunately support for automatic export is severely lacking in diagramming tools.