Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add cardano-chain-follower architectural docs #111

Merged
merged 8 commits into from
Feb 14, 2024

Conversation

FelipeRosa
Copy link

Description

Architectural design docs cardano-chain-follower.

Related Issue(s)

Closes #67.

Description of Changes

Added the initial version of the architectural design docs for the cardano-chain-follower crate.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@FelipeRosa FelipeRosa self-assigned this Feb 5, 2024
@FelipeRosa FelipeRosa added the documentation Pull requests that update a dependency file. label Feb 5, 2024
@minikin minikin added the review me PR is ready for review label Feb 5, 2024
@minikin minikin enabled auto-merge (squash) February 8, 2024 08:55
@minikin
Copy link
Collaborator

minikin commented Feb 13, 2024

@FelipeRosa Can you address comments, please?

@FelipeRosa FelipeRosa force-pushed the feat/cardano-chain-follower-docs branch from 37ce09b to cfd48cb Compare February 14, 2024 06:30
@FelipeRosa
Copy link
Author

@Mr-Leshiy I couldn't the docs for the miniprotocols (the link I had doesn't work anymore). Couldn't find anything specific to Mithril snapshots as well. So I linked to Cardano's network docs and Mithril's GitHub.

Copy link
Contributor

@Mr-Leshiy Mr-Leshiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@minikin minikin merged commit 1cdf753 into main Feb 14, 2024
20 checks passed
@minikin minikin deleted the feat/cardano-chain-follower-docs branch February 14, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update a dependency file. review me PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🛠️ [TASK]: Cardano chain follower architectural design docs
3 participants