docs(usage): document Chainlit on CHAINLIT_PORT under Ray Serve

[Ahmath-Gadji]

The CHAINLIT_PORT env var doc points to the Usage Default ports section to explain Chainlit's location, but that table only covered the default (uvicorn) case — Chainlit at the /chainlit subroute — and never mentioned the Ray Serve behavior.

Adds a note to the Default ports section: when ENABLE_RAY_SERVE=true, the API is served by Ray Serve on RAY_SERVE_PORT and the Chainlit UI runs on its own CHAINLIT_PORT (default 8090) instead of the subroute (confirmed in openrag/api.py, which starts chainlit_app via uvicorn on config.ray.serve.chainlit_port). Also flags that the ${CHAINLIT_PORT}:${CHAINLIT_PORT} mapping in docker-compose.yaml is commented out by default and must be uncommented to expose it.

Summary by CodeRabbit

Release Notes

• Documentation
  • Clarified service routing behavior when using Ray Serve deployment. Ray Serve API now runs on a dedicated port (RAY_SERVE_PORT) while Chainlit UI runs on a separate port (CHAINLIT_PORT, default 8090) rather than a subroute. Added guidance for configuring port mappings in docker-compose configuration.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3e732001-c8af-40b2-95a3-2eda77021b78

📥 Commits

Reviewing files that changed from the base of the PR and between 2655618 and 701fcf9.

📒 Files selected for processing (1)

• docs/content/docs/getting_started/usage.mdx

---

📝 Walkthrough

Walkthrough

A note block is added to the "Default ports" section of the usage documentation. It describes the alternate routing behavior when ENABLE_RAY_SERVE=true: the API is served on RAY_SERVE_PORT, and the Chainlit UI runs on CHAINLIT_PORT (default 8090) instead of the /chainlit subroute, with a pointer to uncomment the relevant port mapping in docker-compose.yaml.

Changes

Ray Serve Mode Documentation

Layer / File(s)	Summary
Ray Serve mode note in Default ports section docs/content/docs/getting_started/usage.mdx	Adds a :::note[Ray Serve mode] block documenting that ENABLE_RAY_SERVE=true routes the Chainlit UI to CHAINLIT_PORT (default 8090) instead of the /chainlit subroute, with guidance to uncomment the port mapping in docker-compose.yaml.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A note hops in, short and bright,
"Ray Serve mode changes the port tonight!"
No /chainlit path, a new door instead,
Uncomment the mapping, the docs have said.
Four lines of truth, the rabbit's delight! 🌟

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: documenting how Chainlit runs on CHAINLIT_PORT under Ray Serve, which is the core focus of the documentation update.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/chainlit-port-ray-serve

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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