Skip to content

docs: document local simulator port/host configuration (#688) - #689

Merged
tbolis-at-mulesoft merged 4 commits into
developfrom
docs/688-simulator-port-config
Sep 28, 2026
Merged

tbolis-at-mulesoft merged 4 commits into
developfrom
docs/688-simulator-port-config

Conversation

@tbolis-at-mulesoft

Copy link
Copy Markdown
Collaborator

Closes #688

Summary

  • Add a "Choosing a port or host" section to simulator.mdx (--port/--host flags, DONKEY_LLM_PROXY_URL match reminder, 0.0.0.0 exposure caveat, uvicorn-8000-vs-simulator-8080 note) plus a "Running the simulator from Python" subsection documenting serve(*, host=, port=, config=).
  • Add a one-line --port pointer in quickstart.mdx and a no-env/toml note + cross-link in the cli.mdx donkey mock reference (BG §1.4).
  • Regenerate the website/public/*.md + llms-full.txt mirrors via npm run generate:llms (source of truth is the pages; llms.txt unchanged since no page title/description changed).

Test plan

  • npm run dev — /simulator, /quickstart, /cli all render the new section/links; #choosing-a-port-or-host renders as a real <h2 id> anchor.
  • npm run generate:llms — diff confined to cli.md, quickstart.md, simulator.md, llms-full.txt.
  • npm run build — succeeds (61 pages, pagefind indexed 59); no further mirror drift post-build.
  • Verified against source: donkey_kit.simulator.serve(*, host="127.0.0.1", port=8080, config=None) is keyword-only and importable; no DONKEY_*PORT env var or .donkey-kit.toml key exists for the simulator port.

Post-deploy steps

None.

🤖 Generated with Claude Code

tbolis-at-mulesoft and others added 4 commits September 28, 2026 12:27
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@tbolis-at-mulesoft
tbolis-at-mulesoft merged commit a325749 into develop Sep 28, 2026
13 checks passed
@tbolis-at-mulesoft
tbolis-at-mulesoft deleted the docs/688-simulator-port-config branch September 28, 2026 11:43
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.

docs: document how to configure the local simulator's port (CLI flag, serve(), no env var)

1 participant