From de650b55af53d7fd1677cc0cbaa0fad97b78286e Mon Sep 17 00:00:00 2001 From: Jefrey Cayab <42927334+jcayab@users.noreply.github.com> Date: Wed, 9 Sep 2026 17:08:12 +0800 Subject: [PATCH] [Docs] Update README.md MkDocs to give option to run dev-server on different port. (#54584) Signed-off-by: jcayab <42927334+jcayab@users.noreply.github.com> Signed-off-by: Jefrey Cayab Signed-off-by: Jefrey Cayab <42927334+jcayab@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> --- docs/contributing/README.md | 6 +++--- docs/getting_started/installation/gpu.apple.inc.md | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/contributing/README.md b/docs/contributing/README.md index 5622315b57..55966f2854 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -120,15 +120,15 @@ uv pip install -r requirements/docs.txt (e.g., `mkdocs-awesome-nav` requires Python 3.10+) MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. -From the root of the repository, run: +From the root of the repository, run the following. Note that by default, the dev-server will run on `127.0.0.1:8000`. Should you want to run the dev-server on a different port, use `-a` like this `mkdocs serve -a localhost:8090`. ```bash mkdocs serve # with API ref (~10 minutes) API_AUTONAV_EXCLUDE=vllm mkdocs serve # API ref off (~15 seconds) ``` -Once you see `Serving on http://127.0.0.1:8000/` in the logs, the live preview is ready! -Open in your browser to see it. +Once you see a `Serving on http://
:/` line in the logs, the live preview is ready! +Open that address in your browser to see it — `http://127.0.0.1:8000/` by default, or whichever host/port you passed to `-a`. For additional features and advanced configurations, refer to the: diff --git a/docs/getting_started/installation/gpu.apple.inc.md b/docs/getting_started/installation/gpu.apple.inc.md index 1a1d37b53b..97228132e3 100644 --- a/docs/getting_started/installation/gpu.apple.inc.md +++ b/docs/getting_started/installation/gpu.apple.inc.md @@ -52,6 +52,9 @@ source ~/.venv-vllm-metal/bin/activate vllm serve ``` +Wait for 2-3 minutes until you see application startup complete: +> INFO: Application startup complete. + Once the server is running, you have multiple options to interact with it: #### Option 1: Interactive chat