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.

Sign up for GitHub

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

Added images to the main blockchain page and to the blockchain system… #1697

Merged
merged 4 commits into from
Oct 16, 2023
Merged

Added images to the main blockchain page and to the blockchain system… #1697

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eee2c1f
Added images to the main blockchain page and to the blockchain system…
spyrostz Oct 16, 2023
8164505
Harmonized image / caption definition in order to be consistent with …
spyrostz Oct 16, 2023
774d9e5
Fixed numbering on the image captions.
spyrostz Oct 16, 2023
491b834
Merge branch 'master' into bc-wiki-images
spyrostz Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions wiki/docs/blockchain-system-components-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ The [Substrate](https://substrate.io/){target=_blank}-based GSy Node is the back

For more, please see the section on [GSy Node Installation, Operation and Development](blockchain-installation.md).



![alt_text](img/blockchain-system-components-overview-1.png)

***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).*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I also prepended the section number in the figure number:
For the BC section this would result in:
Figure 6.1

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Darn, it makes the documentation files a bit ugly, too bad that mkdocs does not natively support this. Will fix, thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also hate that this is not supported be default, but also open to alternatives.
I remember quite some digging though.

Copy link
Member Author

@spyrostz spyrostz Oct 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).



### GSy DEX Matching Engine
The GSy DEX Matching Engine is responsible for identifying suitable matches for energy supply and demand based on the participants' preferences and market conditions. By efficiently matching bids and offers, the engine facilitates a seamless and optimised exchange clearance.

Expand Down
6 changes: 6 additions & 0 deletions wiki/docs/blockchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Full blockchain deployment will be enabled once the following [GSy DEX System Co

The [Energy Web Chain](https://www.energyweb.org/){target=_blank} is the blockchain of choice for the Grid Singularity Exchange decentralised implementation, anchored upon [Polkadot’s](https://polkadot.network/){target=_blank} scaling solution. Grid Singularity, an energy technology startup, and the Rocky Mountain Institute, a nonprofit clean technology organisation, jointly founded the Energy Web Foundation (EWF) in January 2017 as a non-profit entrepreneurial foundation building web3 applications for the energy transition. Having significantly contributed to EWF development and the launch of the Energy Web Chain, Grid Singularity’s role today in the Energy Web is supervisory and advisory via Foundation Council.


![alt_text](img/blockchain-1.png)

***Figure 1***. *Decentralised Peer-to-Peer Energy Exchange (GSY DEX) Architecture (Note: GSY DEX system components, designated in green, interact with the GSy Node for on-chain operations via Energy Web Data Hub that provides a secure and interoperable data exchange service. Grid and asset management services are provided through interoperable API interfaces, as are third party services such as billing and payments).*


**The GSy DEX Design Principles**

The GSy DEX is designed around a set of key principles that guide its development and ensure that it meets the requirements of a modern, efficient, and secure energy trading platform. These design principles are aligned with the use of the Substrate framework for the development of the distributed ledger combined with the definition of a set of complementary ancillary services.
Expand Down
Binary file added wiki/docs/img/blockchain-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/docs/img/blockchain-system-components-overview-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading