Skip to content

[protocol-units] : update READMEs - #685

Merged
l-monninger merged 10 commits into
mainfrom
a-penzkofer/protocol-units-update-readmes
Feb 11, 2025
Merged

[protocol-units] : update READMEs#685
l-monninger merged 10 commits into
mainfrom
a-penzkofer/protocol-units-update-readmes

Conversation

@apenzk

@apenzk apenzk commented Oct 11, 2024

Copy link
Copy Markdown
Contributor

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 left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread protocol-units/sequencing/memseq/sequencer/src/lib.rs Outdated
@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 left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread protocol-units/settlement/mcr/README.md Outdated
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 left a comment

Copy link
Copy Markdown
Contributor

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
nicholasflintwillow pushed a commit that referenced this pull request Mar 9, 2025
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants