Add preliminary draft of architecture.md doc #1341
Closed
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
adizere
reviewed
Sep 28, 2021
docs/architecture/architecture.md
Outdated
| @@ -6,48 +6,71 @@ This document describes the architecture of ibc-rs. If you're looking for a high | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Seems like the picture is not rendered. I would find it useful if we do have an overview diagram, e.g., a system context diagram.
Co-authored-by: Adi Seredinschi <adizere@gmail.com>
16 tasks
|
Closing this PR and opening a new one because I accidentally deleted my fork 😬 |
5 tasks
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.
This is a preliminary draft of an architecture.md doc that aims to cover the overall high-level layout of the ibc-rs crate. I'm roughly following the same structure for this doc that rust-analyzer uses: https://github.com/rust-analyzer/rust-analyzer/blob/d7c99931d05e3723d878bea5dc26766791fa4e69/docs/dev/architecture.md.
Things I want to further flesh out with this doc include: