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

(Docs) Add to README: Clearer indication of optional and required arguments for web5 vc create #325

Closed
7 tasks
Tracked by #322
blackgirlbytes opened this issue Aug 29, 2024 · 2 comments · Fixed by #383
Closed
7 tasks
Tracked by #322

Comments

@blackgirlbytes
Copy link
Contributor

blackgirlbytes commented Aug 29, 2024

🚀 Goal

Improve the Web5 Rust CLI documentation to clearly distinguish between optional and required arguments for the web5 vc create command.

🔑 Tasks

  • Review the current README for web5 vc create
  • Identify all arguments for this command
  • Clearly mark which arguments are required and which are optional
  • Use consistent formatting to distinguish between required and optional arguments
  • Provide examples showing the use of both required and optional arguments
  • Update any existing examples to reflect this clarification
  • Ensure the README is clear and follows the project's documentation style

🌟 Resources

Getting Started

  1. Comment ".take" on this issue to get assigned
  2. Fork the repository and create a new branch for this task
  3. Update the documentation as described in the tasks
  4. Submit a pull request with your changes
  5. Respond to any feedback during the review process

💭 Questions?

If you have any questions or need clarification, please comment on this issue or join our Discord community.
Happy coding! 🎉

@w3irdrobot
Copy link
Contributor

.take

Copy link

github-actions bot commented Oct 7, 2024

Thanks for taking this issue! Let us know if you have any questions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants
@w3irdrobot @blackgirlbytes and others