docs: move the service-specific key-binding table out of README - #380
Conversation
The table had grown to 39 service rows and dominated the TUI section, pushing the palette, saved-views, filtering, and watch-mode prose far below the fold. It now lives in docs/service-specific-highlights.md, registered in the docs map, with a pointer left in README.md. `### Global` stays in README.md — it is the short table people scan on arrival, and the one the new document links back to. Redone against current main rather than landing the earlier attempt, which was cut at dbee17a and had 35 rows: API Gateway v2, AWS Backup, SNS, and WAFv2 were added after it and would have been deleted. Rows were diffed before and after the move and are byte-identical. Documentation movement only; no key binding text changes. Closes #379
|
Warning Review limit reachedNext included review available in 50 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Repository: DevopsArtFactory/unic/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (3)
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. Comment |
![amazon-q-developer[bot]](https://avatars.githubusercontent.com/in/1220912?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation refactoring successfully moves the 39-row service-specific key-binding table from README.md to docs/service-specific-highlights.md, reducing README length from 732 to 692 lines while preserving all content. The change improves README readability by extracting a large table that had grown to dominate the TUI Navigation section.
Verification confirmed:
- All 39 service rows preserved (byte-identical content)
- Bidirectional linking works correctly (
README.md#globalanchor verified at line 561) - New document integrated into docs/README.md document map
- No functional code changes
Approved for 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.
1 participant
Summary
The
### Service-specific highlightstable had grown to 39 service rows and dominated the TUI section, pushing the command palette, saved views, filtering, and watch-mode prose far below the fold. It moves todocs/service-specific-highlights.md, with a pointer left inREADME.mdand an entry in the docs map.### Globalstays inREADME.md— it is the short table people actually scan on arrival, and the one the new document links back to via../README.md#global(anchor target verified present at line 561).README.mdgoes from 732 to 692 lines. No key binding text changed; this is movement only.Redone rather than salvaged
An earlier attempt at this existed as an untracked file cut from
README.mdatdbee17a, 32 commits back. It had 35 service rows against the current 39 — API Gateway v2, AWS Backup, SNS, and WAFv2 were all added after it was taken. Landing it would have silently deleted those four services' key bindings, undoing exactly the README upkeep the CLAUDE.md rule exists to enforce.So the extraction was redone against current
main.Verification that nothing was lost
Diffed the table rows from
origin/main's README against the new document:Byte-identical, and all four previously-missing services confirmed present. I did not hand-patch the stale file — extracting fresh and then diffing is the check that would actually catch a mistake.
Also grepped for anything else referencing the section; only the new pointer and the docs-map entry exist.
Validation
go build ./...andgo test ./...pass, though this touches only MarkdownCloses #379