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: Update pallet docs #1767

Merged
merged 1 commit into from
Mar 13, 2024
Merged

docs: Update pallet docs #1767

merged 1 commit into from
Mar 13, 2024

Conversation

cdamian
Copy link
Contributor

@cdamian cdamian commented Mar 12, 2024

Description

Updates to pallet documentation.

@cdamian cdamian marked this pull request as ready for review March 12, 2024 11:28
@cdamian cdamian requested a review from mustermeiszer as a code owner March 12, 2024 11:28
@cdamian cdamian requested review from hieronx, lemunozm and wischli March 12, 2024 11:28
Copy link
Contributor

@lemunozm lemunozm left a comment

Choose a reason for hiding this comment

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

Incredible fast!! 🚀

Just some minor comments

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

- [**pool-registry**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/pool-registry) ([docs](https://reference.centrifuge.io/pallet_pool_registry/index.html)): Used for creating, updating, and setting the metadata of pools.

- [**pool-system**](https://github.com/centrifuge/centrifuge-chain/tree/main/pallets/pool-system) ([docs](https://reference.centrifuge.io/pallet_pool_system/index.html)): Creating and managing investment pools. It is bundling loans, slicing pools into tranches, and controlling investment epochs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure about the "it is building loans" part 🤔. It is true that it takes into account the loans portfolio but pallet-pool-system does not know anything about loans.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not building, it's bundling ^^. This being the case, I think it's correct, given your mention about the loans portfolio?

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes more sense then 😆

wischli
wischli previously approved these changes Mar 12, 2024
Copy link
Contributor

@wischli wischli left a comment

Choose a reason for hiding this comment

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

Have you been a boyscout? Certainly leaving the repo docs much cleaner and explicit! Two minor nits, definitely not blocking.

README.md Show resolved Hide resolved
pallets/liquidity-pools-gateway/routers/src/lib.rs Outdated Show resolved Hide resolved
@cdamian cdamian force-pushed the pallet-docs-update branch from 18d008a to 23a6f2d Compare March 13, 2024 09:22
Copy link
Contributor

@lemunozm lemunozm left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for taking care of this

Copy link
Collaborator

@mustermeiszer mustermeiszer left a comment

Choose a reason for hiding this comment

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

Nice!

@cdamian cdamian merged commit e3cd441 into main Mar 13, 2024
9 checks passed
@cdamian cdamian deleted the pallet-docs-update branch March 13, 2024 13:02
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.

4 participants