Skip to content

Clean up mpt_holders reference documentation + add Try It #3104

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

Merged
merged 1 commit into from
May 8, 2025

Conversation

maria-robobug
Copy link
Contributor

@maria-robobug maria-robobug commented May 2, 2025

Preview: https://xrpl-dev-portal--mpt-holders-doc-cleanup.preview.redocly.app/docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders

The "Try it" example defaults to a Devnet example request, as I've created an MPT in that environment. I don't have one for Mainnet, but do let me know if we absolutely require this to be Mainnet.

@maria-robobug maria-robobug force-pushed the mpt-holders-doc-cleanup branch from 1e7ccef to 8373039 Compare May 6, 2025 18:06
@maria-robobug maria-robobug marked this pull request as ready for review May 6, 2025 18:06
@maria-robobug maria-robobug changed the title Cleanup mpt_holders reference documentation + add Try It Clean up mpt_holders reference documentation + add Try It May 6, 2025
@maria-robobug maria-robobug linked an issue May 6, 2025 that may be closed by this pull request
@maria-robobug maria-robobug force-pushed the mpt-holders-doc-cleanup branch from 8373039 to bedda2a Compare May 6, 2025 18:22
Copy link
Contributor

@DennisDawson DennisDawson left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@mDuo13 mDuo13 left a comment

Choose a reason for hiding this comment

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

LGTM.

Having the examples on Devnet is best for now—since MPTs are not even enabled on Mainnet yet—but eventually it would be preferable to switch the examples to use Mainnet so that we don't have to re-create the same data every time there's a Devnet reset. Devnet resets are somewhat irregular but can be as often as multiple times per year, whereas on Mainnet we can generally create sample data once and leave it there forever. So that's a task to note for later, but it can't be done until MPT is enabled and there's no need to do anything until the next Devnet reset.

@maria-robobug maria-robobug merged commit cd44b8e into master May 8, 2025
5 of 6 checks passed
@maria-robobug maria-robobug deleted the mpt-holders-doc-cleanup branch May 8, 2025 10:43
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.

mpt_holders documentation needs some cleanup
3 participants