Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for Concent Settlement Algorithm #1109

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

cameel
Copy link
Contributor

@cameel cameel commented Feb 15, 2019

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.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@cameel cameel force-pushed the docs-concent-settlement-algorithm branch from 0dc3895 to 15ec474 Compare February 25, 2019 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Blueprint] Concent Settlement Algorithm
2 participants