-
Notifications
You must be signed in to change notification settings - Fork 454
Update README file to reflect the modular architecture changes - Closes #3075 #3129
Conversation
framework/src/components/README.md
Outdated
|
||
### Logger | ||
|
||
Logger is responsible for all application-level logging activity and logs everything in JSON format. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does it log in JSON format now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As of now no.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We didn't include it in 1.6.0. We should do it in 2.0.
That's something we would have to amend in the LIP if 1.6.0 is about to close the objective.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I deleted the false part for now.
* Default configuration file | ||
* Network specific configuration file | ||
* Custom configuration file (if specified by user) | ||
* Custom configuration file (if specified by the user) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This structure will change in 1.6
and development
branch is dedicated for it, do we need to merge this changes and then update this section again in other PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mona here updated the typos only, which is fine.
framework/src/components/README.md
Outdated
|
||
### Logger | ||
|
||
Logger is responsible for all application-level logging activity and logs everything in JSON format. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As of now no.
Correct the components descriptions
Fix the description typos Co-Authored-By: MaciejBaj <macie.baj@gmail.com>
Change the system component description
Correct modules communication part
What was the problem?
Readme files were missing or missing content.
How did I fix it?
Created Readme files and added missing content.
Documentation is focussing mainly on the corresponding LIP https://github.com/LiskHQ/lips/blob/master/proposals/lip-0005.md, as implementation is still in progress.
How to test it?
Check
README.md
inframework/src/modules
,framework/src/components
,framework/src/controller
Review checklist