docs: lead with the install script and drop a triplicated MCP paragraph - #378
Conversation
Put Install Script before Homebrew under Installation. The Homebrew path needs three commands and a trust decision since Homebrew 6.0.0 (#369); the script is one line with no trust step, so it is the lower-friction entry point for a first-time reader. Both remain documented. This does not close #376 — that asks for one-command `brew install unic`, which is gated on homebrew-core notability — but it is the part available today. Also collapses the "The server provides the read-only resource operations listed above ..." paragraph, which appeared three times in a row with three different example-prompt lists. That was a regression from merging the #360 fills serially: #364, #367 and #368 each edited the sentence to name their own tool, and the conflict resolutions for #367 and #368 kept both sides rather than merging them. The surviving sentence names no example tool, since doing so is what made the line conflict on every fill and the command list above already enumerates them. The six distinct prompts are preserved. Closes #377
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: DevopsArtFactory/unic/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. 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. (3)
🧰 Additional context used📓 Path-based instructions (3)Verify that README changes match actual CLI/TUI behavior and that Currently Implemented Features, TUI Key Bindings, Usage, and Configuration content stay aligned with code changes.⚙️ CodeRabbit configuration file Files:
Source excerpt: **피쳐를 추가, 수정, 삭제할 때 반드시 `README.md`를 함께 업데이트한다.**📄 CodeRabbit inference engine (CLAUDE.md) Files:
When implementation changes affect user-visible behavior, config/auth behavior, service coverage, TUI flow, or contributor workflow: update `README.md` update the relevant file under `docs/` use [`docs/documentation-harness.md`](docs/docume...📄 CodeRabbit inference engine (AGENTS.md) Files:
🔇 Additional comments (1)
WalkthroughThe README now places the Install Script instructions before Homebrew and includes a Kiro prompt for finding failed or rollback CloudFormation stacks and their status reasons. ChangesREADME updates
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~4 minutes Change: Other Merge Risk: ⚪ Minimal · up to The README updates preserve valid installation guidance and consolidate the MCP examples; no merge-blocking risk remains. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Linked Issues checkExplanation Issue
✨ Finishing Touches🧪 Generate unit tests (beta)
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.
This documentation PR successfully accomplishes both stated objectives: reordering the installation methods to lead with the simpler one-line install script, and removing the triplicated MCP paragraph that resulted from merge conflicts. The consolidation correctly preserves all unique example prompts, and the cross-reference on line 181 remains accurate. No defects 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.
1 participant
1. Install Script now comes first
Homebrew needs three commands and a trust decision since Homebrew 6.0.0 (#369). The script is one line with no trust step:
curl -sSL https://raw.githubusercontent.com/DevopsArtFactory/unic/main/install.sh | shBoth paths stay documented; only the order changes.
This does not close #376. That asks for one-command
brew install unicvia homebrew-core, which is gated on notability (17 stars against a 225-star self-submission bar) and would also move release delivery off our tag push onto homebrew-core PRs. Reordering is the part available today.Checked the one sentence that depends on ordering — line 181, "Install it with Homebrew or the install script above" — still correct, since both sections remain above it.
2. A triplicated paragraph, which was my regression
README.mdrepeated "The server provides/exposes the read-only resource operations listed above ..." three times in a row, each with its own example-prompt list.This came from merging the #360 fills serially. #364, #367 and #368 each edited that sentence to name their own tool, and my conflict resolutions for #367 and #368 took both sides instead of merging them. Same class of defect as #317, and caused the same way.
Collapsed to one paragraph with the union of the prompts — six distinct lines, with the two that appeared in all three copies deduplicated:
The surviving sentence deliberately names no example tool. Naming one is exactly what made this line conflict on every single fill, and the command list above it already enumerates them — so this should stop recurring.
Validation
go build ./...andgo test ./...pass, though this change touches only MarkdownCloses #377
Summary by CodeRabbit