Skip to content

docs: remove duplicate README filtering paragraph - #318

Merged
YoungJinJung merged 3 commits into
mainfrom
docs/317-readme-filtering
Aug 26, 2026
Merged

docs: remove duplicate README filtering paragraph#318
YoungJinJung merged 3 commits into
mainfrom
docs/317-readme-filtering

Conversation

@YoungJinJung

Copy link
Copy Markdown
Contributor

Summary

Remove the stale duplicate service/context filtering paragraph from README.md while retaining the authoritative paragraph with the current filtering coverage.

Related Issues

Closes #317

Validation

  • make test
  • make build
  • git diff --check origin/main...HEAD
  • Documentation harness reviewed; no additional docs are affected because runtime behavior, architecture, auth, config, and workflows are unchanged.

Checklist

  • Scope is focused
  • Branch name follows docs/branch-naming-harness.md
  • Documentation harness reviewed (docs/documentation-harness.md)
  • README updated
  • Relevant docs/ pages reviewed; no additional updates required
  • Tests/validation included
  • No breaking changes

- keep the current service filtering coverage list
@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 15 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 8dbb6e85-494d-432a-85b7-968bce69839e

📥 Commits

Reviewing files that changed from the base of the PR and between dbee17a and 8ad2731.

📒 Files selected for processing (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@amazon-q-developer amazon-q-developer 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.

This PR successfully removes a duplicate paragraph about service/context filtering from the README while retaining the more complete and current version. The change improves documentation clarity without affecting functionality. No issues found.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@YoungJinJung YoungJinJung left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The retained coverage list drops CloudFormation stacks, but current main still implements the shared / filter for that screen (internal/app/screen_cloudformation.go and the README key-binding table). Please keep CloudFormation stacks in the surviving paragraph while removing the duplicate.

- keep the surviving README coverage list aligned with the TUI
@YoungJinJung

Copy link
Copy Markdown
Contributor Author

Applied the review request in 37ad4a7 by restoring CloudFormation stacks to the surviving filtering coverage list. Confirmed the screen uses the shared filter, and reran make test, make build, and git diff --check origin/main...HEAD; all passed.

@YoungJinJung

Copy link
Copy Markdown
Contributor Author

Duplicate-checked against my #323 (now closed in favour of this one) — the dedupe and the union of the two coverage lists here are correct.

One optional addition while this paragraph is being touched: four screens have working / filters but appear in neither of the two original copies, so they are still missing after this fix.

security groups, CloudWatch alarms, CloudTrail events, KMS keys

Verified against the code rather than inferred — each has both an activateFilter(<target>) and an updateSharedFilter(msg, <target>) call site, exactly like every entry already listed:

target activateFilter updateSharedFilter
filterSecurityGroups
filterCWAlarms
filterCloudTrailEvents
filterKMSKeys

Suggested placements that keep the existing grouping:

  • EC2 inventory instances, Auto Scaling groups, **security groups**, IAM users
  • CloudWatch metrics, **CloudWatch alarms**, CloudWatch log groups/streams, **CloudTrail events**, Secrets Manager resources
  • SSM parameters, **KMS keys**, ACM certificates

Entirely optional — checklist item 2 ("keep the surviving service coverage list aligned with the current TUI screens") is what prompted it. Fine to land this as-is and treat the four as a follow-up.

- include the four verified shared-filter screens
@YoungJinJung

Copy link
Copy Markdown
Contributor Author

Applied the reviewer follow-up in 8ad2731: added security groups, CloudWatch alarms, CloudTrail events, and KMS keys to the surviving filtering coverage list after verifying each shared-filter code path. make test, make build, and git diff --check all pass.

@YoungJinJung

Copy link
Copy Markdown
Contributor Author

/q review

@amazon-q-developer amazon-q-developer 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.

Documentation cleanup successfully removes the duplicate filtering paragraph while preserving the authoritative version with complete service coverage. The change is straightforward and correct.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@youngjinjung-linq youngjinjung-linq 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.

Verified the complete README-only diff against the current shared-filter call sites. The duplicate is removed, the retained coverage list reflects the implemented screens, is the merge base, and all checks pass.

@YoungJinJung

Copy link
Copy Markdown
Contributor Author

Merge blocker: main requires one approving review. GitHub is not counting the existing youngjinjung-linq approval toward that rule (reviewDecision: REVIEW_REQUIRED, mergeable_state: blocked), and the active YoungJinJung account authored this PR, so it cannot self-approve. CI is green and the current-head diff has already been reviewed; the remaining action is approval from a different collaborator whose review satisfies branch protection. I did not use the available admin bypass.

@YoungJinJung
YoungJinJung merged commit 80b0422 into main Aug 26, 2026
3 checks passed
@YoungJinJung
YoungJinJung deleted the docs/317-readme-filtering branch August 26, 2026 05:27
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.

docs: remove duplicate README filtering paragraph

2 participants