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.

Sign up for GitHub

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

Jump to bottom

[protocol-units] : update READMEs #685

Merged
merged 10 commits into from
Feb 11, 2025
Merged

[protocol-units] : update READMEs #685

merged 10 commits into from
Feb 11, 2025

Conversation

apenzk
Copy link
Contributor

@apenzk apenzk commented Oct 11, 2024 •
edited
Loading

Summary

  • RFCs: $\emptyset$.
  • Categories: protocol-units

Adds READMEs to protocol-units and a couple comments to functions.

Changelog

  • fixes broken README links (adds missing READMEs)
  • expand READMEs if content was missing
  • some minor rust-crate comments on the test file

Testing

n/a

Outstanding issues

This addresses the protocol units sequencer and settlement. README's should be checked for the other categories like storage, syncing, mempool and execution.

0xmovses
0xmovses requested changes Oct 14, 2024
View reviewed changes
Copy link
Contributor

@0xmovses 0xmovses left a comment •
edited
Loading

Choose a reason for hiding this comment

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

The added README for mcr is welcomed, just one suggestion about general approach on comments / docs

@apenzk apenzk requested a review from 0xmovses October 15, 2024 08:56
@apenzk apenzk requested a review from Primata as a code owner October 18, 2024 11:30
@apenzk apenzk removed the request for review from cde8 October 22, 2024 10:04
mzabaluev
mzabaluev previously requested changes Oct 24, 2024
View reviewed changes
Copy link
Collaborator

@mzabaluev mzabaluev left a comment

Choose a reason for hiding this comment

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

Looks good, except one problem with a link.

@apenzk @mzabaluev
Update protocol-units/settlement/mcr/README.md
d3addba 
Co-authored-by: Mikhail Zabaluev <mikhail.zabaluev@movementlabs.xyz>
@apenzk apenzk requested review from mzabaluev and removed request for andyjsbell January 3, 2025 11:03
@apenzk apenzk dismissed mzabaluev’s stale review January 28, 2025 16:24

thanks. this has been addressed

mzabaluev
mzabaluev approved these changes Jan 28, 2025
View reviewed changes
Copy link
Collaborator

@mzabaluev mzabaluev left a comment

Choose a reason for hiding this comment

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

LGTM

@l-monninger l-monninger merged commit 5228d5d into main Feb 11, 2025
90 checks passed
mcmillennick pushed a commit that referenced this pull request Mar 9, 2025
@apenzk @mzabaluev @mcmillennick
docs: update READMEs (#685)
c5f04e7 
Co-authored-by: Mikhail Zabaluev <mikhail.zabaluev@movementlabs.xyz>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mzabaluev mzabaluev mzabaluev approved these changes

@0xmovses 0xmovses 0xmovses approved these changes

@l-monninger l-monninger l-monninger approved these changes

@radupopa369 radupopa369 radupopa369 approved these changes

@Primata Primata Awaiting requested review from Primata

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@apenzk @mzabaluev @0xmovses @l-monninger @radupopa369