feat: add Codacy Cloud CLI documentation#2674
Conversation
Adds a dedicated page for the Codacy Cloud CLI under a new top-level "Codacy Cloud CLI" nav section. Covers installation, authentication, the Codacy Skills integration (Claude Code, Claude.ai, and other AI assistants), a capability reference with grouped command examples, and example workflows. Cross-references added to: Codacy API, API tokens, Issues, and Pull Requests pages. Adds "unignore" to the vale vocabulary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Overall readability score: 54.21 (🟢 +0.03)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for the new Codacy Cloud CLI, including a dedicated index page and integration links within the API and repository documentation. The changes also update the project's vocabulary to include the term 'unignore'. Review feedback focuses on improving the documentation's consistency and accuracy, specifically by capitalizing 'Skills' in headers, clarifying Claude.ai integration steps regarding the Model Context Protocol (MCP), and enhancing the portability of CI examples by using dynamic GitHub Actions variables instead of hardcoded repository names.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the Codacy Cloud CLI. While the documentation is thorough and correctly integrated into the navigation, there is a discrepancy between the intended scope and the actual changes: the update to the Vale vocabulary for the term 'unignore' is missing.
From a technical standpoint, the documentation is up to Codacy standards. However, a security concern was identified regarding the recommendation of passing API tokens as command-line flags, which could lead to accidental exposure in shell histories. Additionally, a minor improvement is suggested for the CI/CD examples to use dynamic GitHub environment variables rather than hardcoded placeholders.
About this PR
- The documentation update is missing the required change to the Vale vocabulary. Please ensure the term 'unignore' is added to the appropriate configuration file to avoid linting errors in the future.
Test suggestions
- Verify the Codacy Cloud CLI navigation entry is correctly placed in mkdocs.yml
- Verify CLI installation and authentication documentation
- Verify documentation for Codacy Skills setup with Claude
- Verify command examples for repositories, issues, findings, and pull requests
- Verify the presence of a CI workflow example using the CLI
- Verify cross-references in existing documentation pages
- Verify 'unignore' is added to the Vale vocabulary
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify 'unignore' is added to the Vale vocabulary
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
Remove --token flag suggestion for CI/CD in favour of the environment variable, which is the standard approach for secrets in pipelines. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 participant
Summary
docs/codacy-cloud-cli/index.mdas a new top-level nav section — installation, authentication, Codacy Skills setup, capability reference with grouped command examples, and example workflowsmkdocs.ymlnav (new "Codacy Cloud CLI" section between Codacy Guardrails and Codacy AI)unignoreto the vale vocabularyVideo
Includes a Loom walkthrough embed.
Test plan
🤖 Generated with Claude Code