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

Update DeWeb CLI docs #355

Merged
merged 9 commits into from
Oct 30, 2024
Merged

Update DeWeb CLI docs #355

merged 9 commits into from
Oct 30, 2024

Conversation

pivilartisant
Copy link
Contributor

We are updating DeWeb CLI docs

@SlnPons
Copy link
Contributor

SlnPons commented Oct 8, 2024

@pivilartisant just a naive question: have you created a --help or any other cmd that list all the available functions on the deweb?

@pivilartisant
Copy link
Contributor Author

@pivilartisant just a naive question: have you created a --help or any other cmd that list all the available functions on the deweb?

yess ideed ! is it worth adding it to the docs ?

@SlnPons
Copy link
Contributor

SlnPons commented Oct 11, 2024

@pivilartisant just a naive question: have you created a --help or any other cmd that list all the available functions on the deweb?

yess ideed ! is it worth adding it to the docs ?

I would say yes so people have a little help at anytime. But I'm not a dev. So I'm not sure it's relevant. Let's wait for @thomas-senechal to review the doc.

Copy link
Member

@thomas-senechal thomas-senechal left a comment

Choose a reason for hiding this comment

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

Sorry, I couldn't comment on lines that were not changed so here is a global comment of all the things I would change:

  • There are still some mentions of the yaml config file (for example line 33)

  • --wallet_nickname has been replaced by:

 -w, --wallet <path>                Path to the wallet file
 -p, --password <password>          Password for the wallet file

IMO we need to explain that ATM only yaml format is supported and how to get it (redirect to MW doc https://docs.massa.net/docs/massaStation/massa-wallet/account-backup and tell to use backup as yaml)

  • We need to explain the possibility to use the secret key in a better way and give the env variable name SECRET_KEY somewhere
  • Examples should be updated to reflect the wallet handle changes (for example, like 99 we use the -w of previous version)
  • edit command has been merged with upload
  • Other commands we added such as ls and show can be ignored for now, but maybe we should rewrite a bit this section to only explain how to upload/edit a website and not how to delete and configure the CLI ? And so, have another section that gives details like the config file, all global options, etc ?

@pivilartisant pivilartisant mentioned this pull request Oct 16, 2024
2 tasks
@thomas-senechal thomas-senechal linked an issue Oct 29, 2024 that may be closed by this pull request
2 tasks
@thomas-senechal thomas-senechal marked this pull request as ready for review October 30, 2024 10:35
@SlnPons SlnPons merged commit 488f3d3 into main Oct 30, 2024
4 checks passed
@SlnPons SlnPons deleted the update-cli-docs branch October 30, 2024 10:36
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.

Improve documentation
3 participants