Add architecture.md and module-level documentation #1556
Merged
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
seanchen1991
requested review from
adizere,
ancazamfir and
romac
as code owners
seanchen1991
added
O: code-hygiene
adizere
reviewed
Nov 11, 2021
|
I think this PR aims to provide guidance to first-time contributors and colleagues onboarding (among others). With that in mind, I'm wondering if @mpoke or @mzabaluev have any thoughts on the architecture.md doc introduced in this PR. Thank you in advance Marius or Mikhail for any feedback! |
adizere
approved these changes
Nov 17, 2021
mzabaluev
reviewed
Nov 17, 2021
|
This comment was somehow attached to a resolved thread, repeating it here: The image has transparent background, some elements are not visible with a Dark theme on GitHub or any other viewer that might use a dark background. |
mpoke
reviewed
Nov 17, 2021
mpoke
reviewed
Nov 17, 2021
mpoke
reviewed
Nov 17, 2021
mpoke
reviewed
Nov 17, 2021
|
ics23 only gets a mention in the diagram, but not otherwise explained. Overall, the document looks good. |
mzabaluev
approved these changes
Nov 19, 2021
hu55a1n1
pushed a commit
to hu55a1n1/hermes
that referenced
this pull request
Sep 13, 2022
) * Add arch doc with mention of flex-error * Add module-level documentation * Add some more module-level documentation * Add some more module-level documentation * Add more module-level documentation * Add Fungible Token Transfer section to arch.md * Fix broken markdown link * Add changelog entry * Run cargo fmt * Incorporate PR feedback * Replace `ibc-rs-layout` image * Fix broken markdown link * Fix broken markdown links * Replace layout image * Change header ordering
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.
Second version of #1341
Description
Adds an architecture.md doc that gives a high-level overview of the structure of
ibc-rs. This doc was written in such a way as to hopefully not require much, if any, updating going forward; we've tried to document invariants and patterns that will hold in perpetuity.Some module-level documentation has also been added.
For contributor use:
unclog.docs/) and code comments.Files changedin the Github PR explorer.