Skip to content

docs: document Pull Requests page filters (search + branch switch) OD-379 - #2724

Merged
claudiacodacy merged 3 commits into
masterfrom
docs-pr-filters-od-379
Aug 6, 2026
Merged

docs: document Pull Requests page filters (search + branch switch) OD-379#2724
claudiacodacy merged 3 commits into
masterfrom
docs-pr-filters-od-379

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Summary

  • Documents the two Pull Requests page filters shipped in OD-377 (SPA) and OD-378 (Cloud CLI), per OD-379:
    • Search box (title/author handle) and All/Current target branch switch on docs/repositories/pull-requests.md.
    • Equivalent codacy pull-requests CLI flags (--search/-q, --base/-B, --state/-S) on docs/codacy-cloud-cli/index.md.
  • Adds a placeholder screenshot (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 the tempPullRequestsPageFilters release toggle. Should be swapped for a real screenshot once the feature is broadly enabled.

Test plan

  • mkdocs build succeeds with no warnings/errors on the touched pages
  • Verified rendered page and TOC anchor in a local preview
  • Swap placeholder image for a real screenshot once available
  • Confirm wording matches shipped UI/CLI labels once the feature flag is on for the reviewer

🤖 Generated with Claude Code

…-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>
@claudiacodacy
claudiacodacy requested a review from a team as a code owner August 6, 2026 09:54
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.93 (🟢 +0)

File Readability
pull-requests.md 67.14 (🟢 +0.66)
index.md 58.91 (🔴 -0.53)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
pull-requests.md 67.14 54.93 9.88 10.1 10.38 6.96
  🟢 +0.66 🔴 -0.1 🟢 +0.25 🔴 -0.1 🔴 -0.06 🟢 +0.15
index.md 58.91 40.24 10.03 11.1 12.17 7.45
  🔴 -0.53 🔴 -0.51 🔴 -0.13 🔴 -0.2 🟢 +0 🟢 +0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.93 42.85 10.93 12.34 12.29 8.04
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 09:56 Inactive
@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/codacy-cloud-cli/index.md
Comment thread docs/repositories/pull-requests.md
Comment thread docs/repositories/pull-requests.md
@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 10:18 Inactive
@claudiacodacy claudiacodacy changed the title docs: document Pull Requests page filters (search + branch switch) docs: document Pull Requests page filters (search + branch switch) OD-374 Aug 6, 2026
@claudiacodacy claudiacodacy changed the title docs: document Pull Requests page filters (search + branch switch) OD-374 docs: document Pull Requests page filters (search + branch switch) OD-379 Aug 6, 2026
@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 10:44 Inactive
@claudiacodacy
claudiacodacy merged commit 16b28ca into master Aug 6, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the docs-pr-filters-od-379 branch August 6, 2026 10:57
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.

3 participants