docs: add documentation describing how the platform is built #17987
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ivan Kavaldzhiev <[email protected]>
poulok
reviewed
Feb 21, 2025
| Here is a diagram illustrating the connection and sequence between all of the builders and key components used to | ||
| construct the `SwirldsPlatform` | ||
|
|
||
|  |
There was a problem hiding this comment.
Unfortunately, I still find my self confused. What is specified by the application and what is not? Why the separation between the PlatformComponentBuilder and the PlatformBuilder? In the diagram, I don't understand why some blocks are green and some are white. If some blocks are required by others, it seems more clear to put those boxes inside of each other to show what top level objects contain the others.
I know this was originally setup very diligently with separation of concerns and allowing the app to specify certain things and not others. This is what I want an explanation for, if possible.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently the logic for building the
SwirldsPlatform, which is the main platform class is a bit complex. In order to give more clarity of how it's constructed and to see easier what steps might be defined to refactor and clean this logic, this documentation is added to the repo.Fixes #17946