pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev
MIT License
15 stars 7 forks source link

[Docs] update supplier actor CLI section #471

Closed bryanchriswhite closed 2 months ago

bryanchriswhite commented 2 months ago

Summary

Updates the "actors" > "supplier actor" > "CLI" section to reflect the refactoring of the proof module out of the supplier module.

image

Issue

Type of change

Select one or more:

Testing

Sanity Checklist

bryanchriswhite commented 2 months ago

This PR does a few things:

  1. Starts conflating supplier and proof in the actors subdirectory

I'm not sure I see the concern. There is no proof actor, what's to conflate?

I updated the copy to try to better represent the distinction between the actor and the modules. I grant you that while a supplier operator MUST use the CLI for the supplier module in order to stake, meanwhile the proof module CLI SHOULD NOT be strictly necessary (i.e. the relayminer binary should do the right thing(s)).

However:

  1. Having CLI tools to "inspect" claim/proof state is part of MVT Features
  2. It would be a supplier operator who would be looking for them should the need arise to claim or prove manually.

Therefore, I feel fairly strongly about including a reference to the proof module CLI in this section.

  1. Creates an extra step for users so they can't simply copy-pasta

I rewrote the codeblocks to be copypastable.

image

  1. Create a docs/types/proof.md so users can really just be 🐒 and copy-paste from the README

I'm not sure I follow the vision here. Creating a file with that path doesn't seem to include it in any navigation as far as I can tell. I'm not sure if this is due to the recent restructuring (#474) or not.