Skip to content

Conversation

@suntiwari3495-arch
Copy link
Contributor

What this PR does / why we need it:
Adds a comprehensive syntax and usage guide for litmusctl. This improves user onboarding and operational clarity by outlining command structures, flags, modes, and core workflows.

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #341

Special notes for your reviewer:

  • The document follows the latest usage and flag conventions.
  • Command examples and best practices included for immediate reference.

Checklist:

@netlify
Copy link

netlify bot commented Oct 24, 2025

Deploy Preview for docs-litmuschaos ready!

Name Link
🔨 Latest commit c2c5348
🔍 Latest deploy log https://app.netlify.com/projects/docs-litmuschaos/deploys/68fcd2b5810c75000853f68d
😎 Deploy Preview https://deploy-preview-404--docs-litmuschaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@vercel
Copy link

vercel bot commented Oct 24, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
litmus-docs Ready Ready Preview Comment Oct 25, 2025 1:46pm

… maintainer

Removed tips and best practices section from litmusctl syntax documentation and updated resource links.

Signed-off-by: suntiwari3495-arch <[email protected]>
@suntiwari3495-arch
Copy link
Contributor Author

@PriteshKiri I have resolved all the reviews.
Please review/merge this PR.

@PriteshKiri
Copy link
Collaborator

PriteshKiri commented Oct 25, 2025

Can you add this new file to sidebar in sidebars.js file?

Once you do this, it will show in the deployment link and will help us review.

Signed-off-by: suntiwari3495-arch <[email protected]>
@suntiwari3495-arch
Copy link
Contributor Author

@PriteshKiri
I have added the file to sidebar.js as instructed, this PR is now ready to be review->merge;

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.

Add litmusctl syntax doc after installation

2 participants