Skip to content

Proposed README edits - #18

Open
a-effort wants to merge 4 commits into
mainfrom
readme/clarify-contextforge-dev-step
Open

Proposed README edits#18
a-effort wants to merge 4 commits into
mainfrom
readme/clarify-contextforge-dev-step

Conversation

@a-effort

@a-effort a-effort commented Aug 12, 2026

Copy link
Copy Markdown

Changes proposed:

  • Clarify that starting mcp-context-forge is a separate repo/process (not a command in this repo), and name make dev and its default port (:8000).
  • Clarify the FASTAPI_URL guidance: .env.example's 4444 default is mcp-context-forge's production default (make serve), not make dev's :8000. Following the doc literally against a make dev instance pointed the BFF at the wrong port.
  • Disambiguate mcp-context-forge (upstream gateway) from contextforge-web-ui (this repo) throughout. The similar names made several "ContextForge" / "this repo" references ambiguous about which project was meant.
  • Replaced em dashes.

@a-effort
a-effort marked this pull request as ready for review August 12, 2026 19:44
AE added 4 commits August 12, 2026 17:29
The step didn't name a command, which read as if this repo had its own
way to bring ContextForge up. Name make dev and its default port, and
say explicitly it's a separate clone.

Signed-off-by: Anna Effort <anna.effort@ibm.com>
.env.example's 4444 default matches ContextForge's production make
serve default, not make dev's :8000 - following the doc literally
against a make dev instance pointed the BFF at the wrong port.

Signed-off-by: Anna Effort <anna.effort@ibm.com>
The repo names are similar enough that shorthand like "ContextForge"
and "this repo" was ambiguous about which project was meant. Spell out
mcp-context-forge and contextforge-web-ui explicitly throughout.

Signed-off-by: Anna Effort <anna.effort@ibm.com>
Signed-off-by: AE <ae@AEs-MacBook-Pro.local>
Signed-off-by: Anna Effort <anna.effort@ibm.com>
@a-effort
a-effort force-pushed the readme/clarify-contextforge-dev-step branch from eebd633 to d3583aa Compare August 13, 2026 00:29
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