Skip to content

Conversation

nbacquey
Copy link

@nbacquey nbacquey commented Aug 27, 2025

Checklist

Updating documentation or Bugfix

The cardano-testnet binary has received many upgrades in the past few months. As a consequence, the documentation page was out of date. This PR aims to fix this.

@rphair rphair changed the title Update the documentation relative to cardano-testnet cardano-testnet: Update documentation Aug 28, 2025
@rphair rphair added the documentation Improvements or additions to documentation label Aug 28, 2025
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

To me this all looks like an improvement but I don't have the relevant experience to evaluate it completely... @gufmar @rdlrt what do you think?

Copy link
Collaborator

@rdlrt rdlrt left a comment

Choose a reason for hiding this comment

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

Looks good, left a check-point comment (tho it's pre-existing link, not added as part of this PR)


Right now, there is no built-in way to stop a running cluster (this will be improved in the future). We recommend using one of these methods to kill a running testnet:
It also gives you some environment variables to export, should you want to use [cardano-cli](https://developers.cardano.org/docs/operate-a-stake-pool/cli-operations/basic-operations/) to interact with the testnet.
Copy link
Collaborator

Choose a reason for hiding this comment

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

should this be relative path?

Copy link
Author

Choose a reason for hiding this comment

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

A relative path should work, but I don't know what the policy is regarding those: they may break more easily if documentation is moved around.

@rphair
Copy link
Collaborator

rphair commented Aug 28, 2025

@nbacquey FYI due to #1631 there is a merge conflict requiring a rebase of this branch or a manual resolution e.g. via GitHub UI.

@nbacquey
Copy link
Author

@rphair merge conflict solved, thanks for your vigilance 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants