Document SeedSigner architecture and flows - #972
Open
etherbiswas wants to merge 1 commit into
Open
Conversation
## Description ### Problem or Issue being addressed The current documentation lacked a detailed breakdown of structure for code, making it hard to make changes for new contributors/devs. ### Solution Modified `README.md` -- Now includes detailed breakdown using Mermaid flowcharts. Covers layer map, boot sequence, main user flow. --- This pull request is categorized as a: - [x] Documentation --- ## Checklist #### I ran `pytest` locally - [x] N/A --- #### I included screenshots of any new or modified screens - [x] N/A --- #### I added or updated tests - [x] N/A --- #### I tested this PR hands-on on the following platform(s): - [x] N/A --- #### I have reviewed these notes: * Keep your changes limited in scope. * If you uncover other issues or improvements along the way, ideally submit those as a separate PR. * The more complicated the PR, the harder it is to review, test, and * We appreciate your efforts, but we're a small team of volunteers so PR review can be a very slow process. * Please only "@" mention a contributor if their input is truly neede - [x] I understand ---
This file contains hidden or 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
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.
Description
Problem or Issue being addressed
The current documentation lacked a detailed breakdown of structure for code, making it hard to make changes for new contributors/devs.
Solution
Modified
README.md-- Now includes detailed breakdown using Mermaid flowcharts. Covers layer map, boot sequence, main user flow.This pull request is categorized as a:
Checklist
I ran
pytestlocallyI included screenshots of any new or modified screens
I added or updated tests
I tested this PR hands-on on the following platform(s):
I have reviewed these notes:
Description
Problem or Issue being addressed
Solution
Additional Information
Screenshots
This pull request is categorized as a:
Checklist
I ran
pytestlocallyI included screenshots of any new or modified screens
Should be part of the PR description above.
I added or updated tests
Any new or altered functionality should be covered in a unit test. Any new or updated sequences require FlowTests.
I tested this PR hands-on on the following platform(s):
I have reviewed these notes:
Thank you! Please join our Devs' Telegram group to get more involved.