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

Mithril-client-updates-and-docs #1741

Conversation

TrevorBenson
Copy link
Collaborator

Updates the mithril-client wrapper script to provide access to each of the mithril-client binaries commands and subcommands for ease of use (provides all the parameters and arguments for each command).

Includes documentation on using the mithril-client.sh to download a latest snapshot, list all snapshots, or show a specific one, as well as download or list available stake-distributions. List and show commands allow json output formats for integration with other tools/purposes.

@TrevorBenson TrevorBenson requested review from rdlrt and Scitz0 March 17, 2024 18:07
@Scitz0
Copy link
Contributor

Scitz0 commented Mar 17, 2024

A few notes looking at the PR.

  • I can see that PR adds information for how the updated mithril-client.sh script operates, but I'm missing the big picture. In my head, I envision a Mithril subsection within the guild docs. This would have a couple of subsections for high-level what mithril is and why it's needed. Just a few sentences. Then installation, client script, and signer(+relay) script. Ie, to deploy mithril you should run guild-deploy.sh with -s m option with information about what this will download and do. Then a section about the client and how it operates, sort of what you added in docs to this PR. But maybe also the cnode.sh integration and env setting omitted what I could see. The last section would be for SPO's to deploy signer and possibly relay. For general information we can just refer to mithril site. In our docs it would be more high level and how the scripts would be used to deploy a "normal" sign setup.
  • As client script now operates differently, cnode.sh needs to be updated as well?

@TrevorBenson
Copy link
Collaborator Author

@rdlrt I've got work underway to resolve the comments by @Scitz0 to provide a global view of Mithril, reference the upsteam docs, and explain the various architectures that can be implemented with the mithril scripts.

Copy link
Contributor

@Scitz0 Scitz0 left a comment

Choose a reason for hiding this comment

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

Looks really good. One thing I noticed was that sidebar.md file had path to mithril-overview as Scripts/mithril-overview.md while actual file seems to reside in Mithril/. I guess changing sidebar.md file would be the easier thing as overview isn't just about the scripts but also general information so fine to keep in separate dir outside of Scripts to me.

EDIT
Can you also please move images to images branch and link to that instead like we have done for other.
that's to make it easier to avoid downloading images when cloning + be able to update image corrections w/o PRs

@TrevorBenson TrevorBenson force-pushed the mithril-client-updates-and-docs branch from c71a315 to 38934fc Compare March 21, 2024 14:52
@TrevorBenson
Copy link
Collaborator Author

@Scitz0 Should be ready for another review.

Copy link
Contributor

@Scitz0 Scitz0 left a comment

Choose a reason for hiding this comment

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

👍

@TrevorBenson TrevorBenson merged commit 2bd1a03 into cardano-community:alpha Mar 21, 2024
1 check passed
rdlrt added a commit that referenced this pull request Mar 21, 2024
rdlrt added a commit that referenced this pull request Mar 21, 2024
@TrevorBenson TrevorBenson deleted the mithril-client-updates-and-docs branch May 1, 2024 17:04
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.

3 participants