fix: gyan/cli-documentation

[gyan-sharma]

Summary by Sourcery

Add comprehensive CLI documentation for SettleMint platform, including detailed command references and usage guides for platform management

New Features:

• Created platform-components.mdx with an overview of SettleMint CLI usage and installation methods
• Added command-reference.mdx with comprehensive documentation for all CLI commands and their options

Documentation:

• Added detailed CLI documentation for SettleMint platform, covering command references for workspace, application, blockchain network, private key, middleware, storage, and integration tool management

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces comprehensive documentation for the SettleMint CLI tool. It includes guides on installation, authentication, project setup, and detailed command references for managing various platform resources like workspaces, applications, blockchain networks, private keys, middleware, storage, integration tools, and insights.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Introduces a new documentation page for the SettleMint CLI tool, detailing its installation, authentication, project connection, and various utilities.	Added documentation for installing the CLI as a project dependency, globally, and via GitHub Actions. Documented the authentication process using Personal Access Tokens (PATs) and the login and logout commands. Explained how to connect a local project to a SettleMint application using the connect command. Described blockchain utilities like retrieving pincode verification responses. Documented the create command for bootstrapping new projects from templates. Detailed the platform commands for managing SettleMint platform resources, including config, create, update, delete, restart, and list. Provided specific examples and options for creating workspaces, applications, blockchain networks (Besu), blockchain nodes (Besu), private keys (HD-ECDSA-P256, HSM-ECDSA-P256, Accessible-ECDSA-P256), middleware (Graph, Smart Contract Portal), storage (IPFS, MinIO), integration tools (Hasura), insights (Blockscout), and application access tokens. Documented the delete commands for workspaces and applications. Documented the list commands for services, workspaces, and applications. Documented the restart commands for blockchain networks, custom deployments, insights, integration tools, and middleware.	content/docs/building-with-settlemint/cli/platform-components.mdx
Adds a comprehensive command reference page for the SettleMint CLI, detailing each command's options, use cases, and examples.	Provided detailed explanations for authentication commands (settlemint login, settlemint logout). Documented project setup commands (settlemint connect, settlemint create, settlemint pincode-verification-response). Explained workspace management commands (settlemint platform create workspace, settlemint platform delete workspace, settlemint platform list workspaces). Documented application management commands (settlemint platform create application, settlemint platform delete application, settlemint platform list applications). Detailed blockchain network commands (settlemint platform create blockchain-network besu, settlemint platform create blockchain-node besu, settlemint platform restart blockchain-network). Explained private key management commands (settlemint platform create private-key hd-ecdsa-p256, settlemint platform create private-key hsm-ecdsa-p256, settlemint platform create private-key accessible-ecdsa-p256). Documented middleware management commands (settlemint platform create middleware graph, settlemint platform create middleware smart-contract-portal, settlemint platform restart middleware graph, settlemint platform restart middleware smart-contract-portal). Explained storage management commands (settlemint platform create storage ipfs, settlemint platform create storage minio). Documented integration tool management commands (settlemint platform create integration-tool hasura). Explained insights management commands (settlemint platform create insights blockscout). Documented application access token management commands (settlemint platform create application-access-token). Detailed platform configuration command (settlemint platform config).	content/docs/building-with-settlemint/cli/command-reference.mdx
Adds meta.json file for the CLI documentation.	Added a meta.json file for the CLI documentation.	content/docs/building-with-settlemint/meta.json
Adds meta.json file for the CLI documentation.	Added a meta.json file for the CLI documentation.	content/docs/building-with-settlemint/cli/meta.json

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @gyan-sharma - I've reviewed your changes - here's some feedback:

Overall Comments:

• It would be helpful to include a section on troubleshooting common errors encountered while using the CLI.
• Consider adding a contribution guide outlining how others can contribute to the CLI documentation.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Review instructions: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}