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(pool-manager): add readme to pool manager #356

Merged
merged 1 commit into from
May 21, 2024

Conversation

kerber0x
Copy link
Contributor

Description and Motivation

This PR adds information about the functioning of the pool manager to its readme file.

Related Issues


Checklist:

  • I have read Migaloo's contribution guidelines.
  • My pull request has a sound title and description (not something vague like Update index.md)
  • All existing and new tests are passing.
  • I updated/added relevant documentation.
  • The code is formatted properly cargo fmt --all --.
  • Clippy doesn't report any issues cargo clippy -- -D warnings.
  • I have regenerated the schemas if needed cargo schema.

Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (0f77427) to head (235a0e6).
Report is 3 commits behind head on release/v2_contracts.

Additional details and impacted files
@@                   Coverage Diff                    @@
##           release/v2_contracts     #356      +/-   ##
========================================================
+ Coverage                 90.09%   90.55%   +0.45%     
========================================================
  Files                       278      276       -2     
  Lines                     29604    29921     +317     
========================================================
+ Hits                      26673    27094     +421     
+ Misses                     2931     2827     -104     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@0xFable 0xFable left a comment

Choose a reason for hiding this comment

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

LGTM, we could mention more on routing and reuse more of router.md but im fine with it as is great work ser 🚀

@kerber0x
Copy link
Contributor Author

LGTM, we could mention more on routing and reuse more of router.md but im fine with it as is great work ser 🚀

I in purpose omitted details about it cuz it's not critical to understand how the contract works and what you can do about it. We already mention that it can do single and multi-hop operations and what messages you need to use for them, i think that's enough. Then when we link to the technical docs there will be examples on how those messages should look like.

@kerber0x kerber0x force-pushed the docs/pool-manager-readme branch from 235a0e6 to de068f9 Compare May 21, 2024 12:46
@kerber0x kerber0x merged commit 4210f60 into release/v2_contracts May 21, 2024
5 checks passed
@kerber0x kerber0x deleted the docs/pool-manager-readme branch May 21, 2024 12:47
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