Skip to content

docs: reconcile canonical service inventories - #331

Open
YoungJinJung wants to merge 1 commit into
mainfrom
docs/330-service-inventories
Open

docs: reconcile canonical service inventories#331
YoungJinJung wants to merge 1 commit into
mainfrom
docs/330-service-inventories

Conversation

@YoungJinJung

@YoungJinJung YoungJinJung commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • reconcile the English and Korean supported-service inventories with the domain catalog
  • include every active repository client and the missing user-facing screen families
  • align the README service and keybinding tables for Parameter Store and API Gateway v2

Related Issues

Closes #330

Validation

  • make test
  • make build
  • git diff --check

Checklist

  • Scope is focused
  • Branch name follows docs/branch-naming-harness.md
  • Documentation harness reviewed (docs/documentation-harness.md)
  • README updated for the confirmed catalog and keybinding drift
  • Relevant docs/ pages updated
  • Tests/validation included
  • Breaking changes documented (none)

Summary by CodeRabbit

  • Documentation
    • Updated supported-service lists to include CloudWatch Alarms, CloudTrail, EKS, Bedrock, AWS Backup, API Gateway v2, ELB, Parameter Store, and other newly documented areas.
    • Added API Gateway v2 navigation, filtering, refresh, detail, and action key references.
    • Refreshed architecture documentation to reflect current service integrations, screens, and workflows, including queues, alarms, load balancers, Lambda, and Parameter Store.
    • Clarified WAF and CloudFront coverage.

- align English and Korean service and repository client lists
- document missing screen families and README API Gateway entries

@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 update successfully reconciles service inventories across English and Korean documentation with the domain catalog. All changes improve consistency and completeness without introducing defects:

  • README service catalog table now includes API Gateway v2 and uses consistent "Parameter Store" naming aligned with the keybinding table
  • Architecture documents reorganize repository client lists to match domain catalog ordering and add missing screen file references (reachability, cloudtrail, eventbridge, etc.)
  • Project overview documents expand service lists to include all active repository clients (CloudWatch Alarms, CloudTrail, EKS, SQS, ELB, Bedrock, AWS Backup, API Gateway v2)
  • English and Korean versions maintain parallel structure

All additions reference services/screens that already exist in the codebase. The changes are ready to merge.


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.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 43c53249-3e53-4e8c-b23f-58ec680cf58d

📥 Commits

Reviewing files that changed from the base of the PR and between c86c676 and 39210cf.

📒 Files selected for processing (5)
  • README.md
  • docs/architecture.en.md
  • docs/architecture.ko.md
  • docs/project-overview.en.md
  • docs/project-overview.ko.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: test
🧰 Additional context used
📓 Path-based instructions (3)
Verify that README changes match actual CLI/TUI behavior and that

⚙️ CodeRabbit configuration file

Files:

  • README.md
Documentation must match implemented behavior. When both English and

⚙️ CodeRabbit configuration file

Files:

  • docs/project-overview.en.md
  • docs/architecture.ko.md
  • docs/project-overview.ko.md
  • docs/architecture.en.md
When adding, modifying, or deleting features, always update `README.md` in parallel with code changes

📄 CodeRabbit inference engine (CLAUDE.md)

Files:

  • README.md
🔇 Additional comments (5)
docs/project-overview.en.md (1)

13-42: LGTM!

docs/project-overview.ko.md (1)

13-42: LGTM!

docs/architecture.en.md (1)

93-123: LGTM!

Also applies to: 171-199, 277-278, 292-297

docs/architecture.ko.md (1)

93-123: LGTM!

Also applies to: 171-199, 277-278, 292-297

README.md (1)

326-334: LGTM!

Also applies to: 477-477


Walkthrough

The documentation inventories now include implemented AWS services, repository clients, TUI screens, and API Gateway v2 controls. English and Korean project and architecture documents remain aligned, and the README service tables reflect the updated service names and actions.

Changes

Documentation inventory reconciliation

Layer / File(s) Summary
Supported service inventories
docs/project-overview.en.md, docs/project-overview.ko.md
The project overviews add CloudWatch Alarms, CloudTrail, EKS, SQS, ELB, Parameter Store, Bedrock, AWS Backup, and API Gateway v2, and reorder existing services.
Repository and screen inventories
docs/architecture.en.md, docs/architecture.ko.md
The architecture documents expand repository-client and screen-file lists, refine WAFv2 and CloudFront entries, and add CloudTrail, CloudWatch Alarms, SQS, ELB, Parameter Store, Lambda, and Bedrock screen flows.
README service catalog and controls
README.md
The AWS catalog renames SSM Parameter Store to Parameter Store and adds API Gateway v2 service and keybinding documentation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 39210

This PR reconciles service inventories and README keybinding documentation without changing product or runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: nathanhuh

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The changes address the linked issue's architecture inventories, screen families, README tables, and most project-overview updates. However, the English project overview summary does not include SQS, … Update docs/project-overview.en.md to include SQS and verify that both project-overview documents contain the same implemented service areas and use code-consistent names.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title uses the required docs: conventional prefix and accurately describes the documentation inventory reconciliation.
Description check ✅ Passed The description includes all required template sections, links issue #330, explains the changes, records validation commands, and completes the checklist.
Out of Scope Changes check ✅ Passed The changes are limited to README and architecture/project-overview documentation. The additions support the linked issue's service, repository-client, and screen-family inventory reconciliation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The changes address the linked issue's architecture inventories, screen families, README tables, and most project-overview updates. However, the English project overview summary does not include SQS, although issue #330 requires adding every implemented service area and the Korean overview includes SQS.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/330-service-inventories

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.

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

Reviewed the complete diff against #330 and the current catalog, repository wiring, screen files, and TUI handlers. The service/client/screen inventories and README keybindings match the implementation, and the English/Korean updates stay aligned. Verified locally with make test, make build, and git diff --check.

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: reconcile canonical service inventories with implemented catalog

2 participants