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: BLS Aggregator Service #387

Open
wants to merge 28 commits into
base: dev
Choose a base branch
from

Conversation

damiramirez
Copy link
Contributor

@damiramirez damiramirez commented Mar 11, 2025

What Changed?

This PR adds documentation to the lib.rs file. We use simple_mermaid to render a Mermaid diagram in docs.rs. Also create a new target make docs to generate the workspace documentation.

To review the docs of BLSAggregator:

cargo doc -p eigen-services-blsaggregation --no-deps --open

Related #380

Reviewer Checklist

  • New features are tested and documented
  • PR updates the changelog with a description of changes
  • PR has one of the changelog-X labels (if applies)
  • Code deprecates any old functionality before removing it

@damiramirez damiramirez marked this pull request as ready for review March 26, 2025 17:42
pablodeymo
pablodeymo previously approved these changes Mar 26, 2025
pablodeymo
pablodeymo previously approved these changes Mar 26, 2025
@damiramirez damiramirez changed the title docs: update BLSAggregator README docs: BLS Aggregator Service Mar 26, 2025
@pablodeymo pablodeymo enabled auto-merge (squash) March 27, 2025 17:12
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.

2 participants