Skip to content

CLI-152 Regenerate README docs#109

Merged
kirill-knize-sonarsource merged 1 commit intomasterfrom
CLI-152-regenerate-docs
Mar 16, 2026
Merged

CLI-152 Regenerate README docs#109
kirill-knize-sonarsource merged 1 commit intomasterfrom
CLI-152-regenerate-docs

Conversation

@kirill-knize-sonarsource
Copy link
Member

No description provided.

@sonar-review-alpha
Copy link

sonar-review-alpha bot commented Mar 16, 2026

Summary

This PR regenerates the README documentation to reflect changes in the CLI:

  • Command rename: sonar analyze a3ssonar analyze sqaa (reflects product branding update)
  • Enhanced documentation: Options table added for sonar analyze sqaa with --file, --branch, and --project parameters
  • New command: sonar verify added with description "Analyze a file for issues"

The large diff reflects a documentation regeneration process (likely auto-generated from CLI help text or a documentation script). Focus review on the README.md changes to verify the command names, descriptions, and option documentation are correct.

What reviewers should know

This PR comment provides reviewers with:

  1. High-level overview of what changed in the documentation
  2. Key details about the command rename (A3S → SQAA)
  3. Information about newly documented options and commands
  4. Guidance on where to focus review effort (README.md changes)
  5. Context that this is a documentation regeneration, not feature development

  • Generate Walkthrough
  • Generate Diagram

🗣️ Give feedback

@hashicorp-vault-sonar-prod
Copy link

hashicorp-vault-sonar-prod bot commented Mar 16, 2026

CLI-152

@sonarqubecloud
Copy link

@kirill-knize-sonarsource kirill-knize-sonarsource merged commit 204c01d into master Mar 16, 2026
12 checks passed
@kirill-knize-sonarsource kirill-knize-sonarsource deleted the CLI-152-regenerate-docs branch March 16, 2026 16:17
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.

2 participants