Added images to the main blockchain page and to the blockchain system… #1697
Conversation
… components overview page.
|
|
||
|  | ||
|
|
||
| ***Figure 1***. *GSY DEX On-Chain Operations via GSY Node (Note: Order Book is where bids and offers are stored, to be then matched based on the applicable trading mechanism for price verification and executed based on energy delivery verification).* |
There was a problem hiding this comment.
Hey, I took the liberty in my last PR to homogenize the images and used the following html snippet (under: "Add figure caption" here: https://github.com/gridsingularity/gsy-e/tree/master/wiki#images
This will connect the image with its caption
Could you also please follow this?
There was a problem hiding this comment.
Also, I also prepended the section number in the figure number:
For the BC section this would result in:
Figure 6.1
There was a problem hiding this comment.
Darn, it makes the documentation files a bit ugly, too bad that mkdocs does not natively support this. Will fix, thanks
There was a problem hiding this comment.
I also hate that this is not supported be default, but also open to alternatives.
I remember quite some digging though.
There was a problem hiding this comment.
Also, I also prepended the section number in the figure number:
For the BC section this would result in:
Figure 6.1
BTW I do not like this at all. I will follow this for consistency's purpose however this means that if we insert one new section after current section #1, we will have to change the figure numbers of all the sections apart from 1. Regardless, let me do it and if we stumble upon it we will see how to deal with it.
There was a problem hiding this comment.
I also thought about this, but thought that this will be kind of easy with a search & replace. Of course, this search&replace will have to be performed n times and if the number of sections is increased a lot, this is not so quick any more.
If we do not follow this "sectionisation", we will have to change all figure names if we want to insert a figure in section 1 by hand or we will have a Figure 82 below Figure 1 (not that I care that much about that, just wanted to outline my reasoning).
…the rest of the documentation.
… components overview page.
Reason for the proposed changes
Please describe what we want to achieve and why.
Proposed changes
INTEGRATION_TESTS_BRANCH=master
GSY_FRAMEWORK_BRANCH=master