docs: document Pull Requests page filters (search + branch switch) OD-379 - #2724
Conversation
…-379 Adds the search box (title/author handle) and the All/Current target branch switch shipped on the repository Pull Requests page, plus the equivalent codacy pull-requests CLI flags (--search/-q, --base/-B). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Overall readability score: 53.93 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
This PR provides documentation for the new Pull Request filtering capabilities. While the UI search and branch filtering descriptions are well-implemented, there is a documentation gap regarding the Codacy Cloud CLI flags, specifically the --state/-S flag and its relationship to the UI.
Codacy analysis shows the PR is up to standards. However, ensure that the temporary placeholder screenshot is replaced before the final release to maintain documentation quality.
About this PR
- The documentation currently uses a placeholder screenshot. Ensure this is replaced with the final UI version before the feature release.
Test suggestions
- Verify that UI documentation explicitly mentions the 3-character minimum for search.
- Verify that CLI documentation lists all specified flags including short aliases (-q, -B, -S).
- Verify that the relationship between UI 'Open/Closed' tabs and the CLI '--state' flag is documented.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that CLI documentation lists all specified flags including short aliases (-q, -B, -S).
2. Verify that the relationship between UI 'Open/Closed' tabs and the CLI '--state' flag is documented.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
Summary
docs/repositories/pull-requests.md.codacy pull-requestsCLI flags (--search/-q,--base/-B,--state/-S) ondocs/codacy-cloud-cli/index.md.docs/repositories/images/pull-requests-filters.png), mocked up from the shipped component code — the real GitHub PR screenshots aren't fetchable without an authenticated session, and the feature is still behind thetempPullRequestsPageFiltersrelease toggle. Should be swapped for a real screenshot once the feature is broadly enabled.Test plan
mkdocs buildsucceeds with no warnings/errors on the touched pages🤖 Generated with Claude Code