Skip to content

fix misleading localhost comment for proxy_1 service URL#37

Open
erenyegit wants to merge 1 commit intogetoptimum:mainfrom
erenyegit:docs/fix-proxy1-localhost
Open

fix misleading localhost comment for proxy_1 service URL#37
erenyegit wants to merge 1 commit intogetoptimum:mainfrom
erenyegit:docs/fix-proxy1-localhost

Conversation

@erenyegit
Copy link

@erenyegit erenyegit commented Feb 5, 2026

What changed

  • Fixed an incorrect comment that labeled proxy_1 as localhost in the CLI getting-started guide.
  • Updated the example to use the correct Docker network service URL.

Why this matters

  • proxy_1 is a Docker service hostname and is not reachable via localhost.
  • The previous example caused copy/paste failures for users running commands outside the Docker network.
  • This change prevents confusion and aligns the documentation with actual Docker networking behavior.

Scope

  • Documentation-only change (no code or behavior changes).

Summary by CodeRabbit

  • Documentation
    • Updated CLI getting started guide with corrected example URLs for docker network environments, clarifying configuration for publish and subscribe operations.

@vercel
Copy link

vercel bot commented Feb 5, 2026

Someone is attempting to deploy a commit to the Optimum Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

Updated development-mode example URLs in the getting-started CLI guide from localhost proxy endpoint (port 8081) to docker network endpoint (port 8080), with corresponding commentary adjustments reflecting the network context change.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/guides/01-getting-started-cli.md
Updated example URLs from http://proxy_1:8081 to http://proxy_1:8080 and changed commentary references from localhost to docker network.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • hpsing

Poem

🐰 A docker hop, a port we've changed,
From 8081 to 8080 arranged,
No localhost, but network true,
The guide now shines in proxy's hue! 🌐

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main documentation change: correcting a misleading localhost comment for the proxy_1 service URL.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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.

1 participant