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

docs: Add documentation to btccheckpoint module #147

Merged
merged 6 commits into from
Oct 14, 2024

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Oct 8, 2024

Summary

There is currently nothing documenting the code for btccheckpoint module. This adds information on the following: state, messages, endblocker, queries and general concepts regarding the module.

Copy link
Collaborator

@KonradStaniec KonradStaniec left a comment

Choose a reason for hiding this comment

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

Some initial comments

x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
@samricotta samricotta marked this pull request as ready for review October 11, 2024 11:33
@samricotta samricotta requested a review from a team as a code owner October 11, 2024 11:33
@samricotta samricotta requested review from gitferry and KonradStaniec and removed request for a team October 11, 2024 11:33
Copy link
Collaborator

@KonradStaniec KonradStaniec left a comment

Choose a reason for hiding this comment

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

just minor comments, lgtm!

x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
Copy link
Member

@Lazar955 Lazar955 left a comment

Choose a reason for hiding this comment

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

Nice write up

x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
Copy link
Member

@gitferry gitferry left a comment

Choose a reason for hiding this comment

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

Great work! Some nits:

x/btccheckpoint/README.md Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@maurolacy maurolacy left a comment

Choose a reason for hiding this comment

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

Just some comments about syntax and repeated stuff.

x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Outdated Show resolved Hide resolved
x/btccheckpoint/README.md Show resolved Hide resolved
@samricotta samricotta merged commit 4996ca1 into main Oct 14, 2024
19 checks passed
@samricotta samricotta deleted the btc-checkpointing-docs branch October 14, 2024 15:26
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.

5 participants