docs(macos-install): drop brew install as primary; one-click curl is the only step#867
Merged
Merged
Conversation
kapishupadhyay22
approved these changes
May 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the macOS server installation doc to ensure Google’s HowTo rich result emphasizes the curl one-click installer (and not the currently-broken Homebrew path), while reorganizing Docker Desktop/Colima content under a single Manual Setup section.
Changes:
- Replace the page-level HowTo JSON-LD to a single step for the curl one-click install and comment out the Homebrew HowTo step.
- Comment out (not delete) the “Install with Homebrew” section content so it can be restored later.
- Reframe Docker Desktop + Colima instructions under a new
## Manual Setupsection and remove Homebrew/brew-install signaling from metadata (description/keywords).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gouravkrosx
force-pushed
the
docs/macos-install-remove-brew
branch
from
75e3131 to
eda463a
Compare
…the only step Google's HowTo rich result for "install keploy macOS" was surfacing `brew install keploy` as step 1 (likely pulled from external Homebrew indexes), pushing the canonical curl one-liner to step 2. - Reduce the page's HowTo JSON-LD to a single step: the curl one-click install. - Comment out (don't delete) the "Install with Homebrew" section and its HowTo step so it can be restored once the keploy/tap formula issues are resolved. - Promote Docker Desktop + Colima to a single `## Manual Setup` section with sub-headings, since they're eBPF-environment setup, not a competing install method. - Strip `homebrew` / `brew install keploy` from frontmatter keywords and the page description so we stop signaling brew as an install path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com>
gouravkrosx
force-pushed
the
docs/macos-install-remove-brew
branch
from
eda463a to
4c9b899
Compare
Vale flagged "KTests" and "KMocks" as misspellings in the macOS install doc (and the v2/v3 archived versions of the same page). They are Keploy-specific proper nouns for recorded test cases and mocks, used intentionally in the prose. Add them to the Base accept vocabulary so docs touching these files stop tripping vale-doc-linter. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com>
4 tasks
Aditya-eddy
pushed a commit
that referenced
this pull request
May 29, 2026
* docs(macos-install): restore Homebrew install as option 2 Revert the Homebrew comment-outs from #867 now that the keploy/tap formula is expected to work. Restores `brew install keploy/tap/keploy` as a second documented install path, alongside the one-click curl installer which remains the recommended primary option. - Re-enable the "Install with Homebrew" HowTo schema step (now step 2, curl one-click stays as step 1 / recommended). - Re-add the visible "## Install with Homebrew" section. - Restore the two-option intro list; keep Manual Setup as the eBPF fallback below. - Put `homebrew` / `brew install keploy` back in frontmatter keywords and the page description. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> * docs(macos-install): drop em-dash in intro list to satisfy Vale Vale's Google.EmDash rule flags ` — ` (space-em-dash-space) in the visible markdown prose. The HowTo JSX block is BlockIgnored in .vale.ini, but the intro list outside it isn't. Reword the recommended marker as a bold prefix instead of an em-dash trailer. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> --------- Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
brew install keployas step 1, pushing the canonical curl one-liner to step 2. The brew path is also broken right now (keploy/tapformula issues being resolved).Install with Homebrewsection + its HowTo step so it can be restored once the tap is fixed.## Manual Setupsection with sub-headings — they're eBPF-environment setup, not competing install methods.homebrew/brew install keployfrom frontmatter keywords and the page description so we stop signaling brew as an install path.Test plan
npm run buildsucceeds (verified locally — no MDX errors)./docs/server/macos/installation/renders with only the curl one-click step + Manual Setup section; no Homebrew section visible.HowToblock has a singleHowToStep./docs/server/macos/installation/in Google Search Console so the stale brew snippet drops out faster.🤖 Generated with Claude Code