Skip to content

Document SeedSigner architecture and flows - #972

Open
etherbiswas wants to merge 1 commit into
SeedSigner:devfrom
etherbiswas:patch-1
Open

Document SeedSigner architecture and flows#972
etherbiswas wants to merge 1 commit into
SeedSigner:devfrom
etherbiswas:patch-1

Conversation

@etherbiswas

@etherbiswas etherbiswas commented Aug 1, 2026

Copy link
Copy Markdown

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:

  • Documentation

Checklist

I ran pytest locally

  • N/A

I included screenshots of any new or modified screens

  • N/A

I added or updated tests

  • N/A

I tested this PR hands-on on the following platform(s):

  • 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
  • I understand

Description

Problem or Issue being addressed

Solution

Additional Information

Screenshots


This pull request is categorized as a:

  • New feature
  • Bug fix
  • Code refactor
  • Documentation
  • Other

Checklist

I ran pytest locally

  • All tests passed before submitting the PR
  • I couldn't run the tests
  • N/A

I included screenshots of any new or modified screens

Should be part of the PR description above.

  • Yes
  • No
  • N/A

I added or updated tests

Any new or altered functionality should be covered in a unit test. Any new or updated sequences require FlowTests.

  • Yes
  • No, I’m a fool
  • N/A

I tested this PR hands-on on the following platform(s):


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 merge.
  • 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 needed to enable further progress.
  • I understand

Thank you! Please join our Devs' Telegram group to get more involved.

## 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

---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant