docs: update README for current ModelExpress capabilities

[ganeshku1]

Summary

• update the top-level README to reflect shipped ModelExpress capabilities on latest main
• clarify ingress reduction, distributed registry, provider support, ModelStreamer, GDS, and air-gapped operation
• link the deployment guide back to the air-gapped overview
• keep roadmap items limited to work that is not yet merged

Testing

• git diff --check -- README.md docs/DEPLOYMENT.md

Summary by CodeRabbit

• Documentation
  • Repositioned ModelExpress documentation to emphasize intelligent model distribution, coordinated downloads, and multiple model source support.
  • Added comprehensive deployment guidance including air-gapped operations, backend prerequisites, and provider patterns.
  • Enhanced offline operation documentation reference.

[coderabbitai]

Walkthrough

ModelExpress documentation is substantially rewritten to reposition the project as an intelligent model distribution control layer, emphasizing coordinated downloads, air-gapped deployment patterns, and distributed state coordination. README narrative and features are updated; new sections cover provider patterns and deployment scenarios. DEPLOYMENT.md reference is refreshed.

Changes

Cohort / File(s)	Summary
Documentation Repositioning README.md	Comprehensive rewrite repositioning ModelExpress as distribution/control layer; architecture narrative updated to reflect coordinated downloads, multiple model sources, direct GPU loading; new sections for air-gapped guidance, provider patterns, and deployment examples added; some roadmap priorities removed.
Deployment Guide Updates docs/DEPLOYMENT.md	Introductory reference updated to include additional link to air-gapped operation section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A rabbit hops through words with care,
Repositioning clouds into the air,
With offline paths and downloads sincere,
ModelExpress's purpose grows crystal clear! ✨

🚥 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 clearly and specifically describes the main change: updating the README to reflect current ModelExpress capabilities. It matches the primary focus of the changeset.
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.}

---

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

_{Review rate limit: 0/1 reviews remaining, refill in 60 minutes.}

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

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

107-122: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win

Convert ASCII art to mermaid diagram.

The architecture diagram uses ASCII art with box-drawing characters. As per coding guidelines, markdown files should use mermaid diagrams instead of ASCII art for better maintainability and rendering.

🎨 Proposed mermaid diagram

-```
-                    ┌─────────────────────────────────────────────────────────────────┐
-                    │                    ModelExpress Server                          │
-                    │   Health • Model • P2P Metadata • Redis/K8s CRD backends        │
-                    └──────────────────────┬──────────────────────────────────────────┘
-                                           │
-                         ┌─────────────────┼─────────────────┐
-                         │ metadata        │                 │ metadata
-                         ▼                 │                 ▼
-              ┌──────────────────┐         │       ┌──────────────────┐
-              │  Source (vLLM)   │  RDMA   │       │  Target (vLLM)   │
-              │  mx loader       │════════►│       │  mx loader       │
-              │  Load → NIXL     │  NIXL   │       │  Receive → FP8   │
-              │  Publish metadata│         │       │  Serve inference │
-              └──────────────────┘         │       └──────────────────┘
-```
+```mermaid
+graph TB
+    Server["ModelExpress Server<br/>Health • Model • P2P Metadata<br/>Redis/K8s CRD backends"]
+    Source["Source (vLLM)<br/>mx loader<br/>Load → NIXL<br/>Publish metadata"]
+    Target["Target (vLLM)<br/>mx loader<br/>Receive → FP8<br/>Serve inference"]
+    
+    Server -->|metadata| Source
+    Server -->|metadata| Target
+    Source ==>|RDMA/NIXL| Target
+```

As per coding guidelines: "Use mermaid diagrams instead of ASCII art in markdown files."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 107 - 122, Replace the ASCII art block with a mermaid
diagram: create a ```mermaid``` code block using graph TB and define nodes named
Server, Source, and Target (matching the proposed labels) and connect them with
Server -->|metadata| Source, Server -->|metadata| Target, and Source
==>|RDMA/NIXL| Target; ensure each node includes the same multi-line content
(use HTML <br/> or sublabels) so the diagram content and edge labels match the
original ASCII diagram.

🧹 Nitpick comments (1)

docs/DEPLOYMENT.md (1)

8-8: 💤 Low value

Consider rephrasing to reduce repetition.

Three consecutive sentences begin with "For," which creates minor repetition. Consider consolidating:

♻️ Suggested rewording

-User-facing guide for configuring and deploying ModelExpress. For architecture details, see [`ARCHITECTURE.md`](ARCHITECTURE.md). For development setup, see [`../CONTRIBUTING.md`](../CONTRIBUTING.md). For a concise overview of offline operation, see the air-gapped section in [`../README.md`](../README.md).
+User-facing guide for configuring and deploying ModelExpress. See [`ARCHITECTURE.md`](ARCHITECTURE.md) for architecture details, [`../CONTRIBUTING.md`](../CONTRIBUTING.md) for development setup, and the air-gapped section in [`../README.md`](../README.md) for offline operation.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/DEPLOYMENT.md` at line 8, The three consecutive sentences starting "For
architecture details, ...", "For development setup, ...", and "For a concise
overview..." are repetitive; rewrite that fragment so the three links are
combined into a single sentence (e.g., "See ARCHITECTURE.md for architecture
details, CONTRIBUTING.md for development setup, and the air-gapped section in
README.md for offline operation."), replacing the three "For ..." sentences with
one concise, comma-separated sentence while preserving each link and context.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@README.md`:
- Around line 107-122: Replace the ASCII art block with a mermaid diagram:
create a ```mermaid``` code block using graph TB and define nodes named Server,
Source, and Target (matching the proposed labels) and connect them with Server
-->|metadata| Source, Server -->|metadata| Target, and Source ==>|RDMA/NIXL|
Target; ensure each node includes the same multi-line content (use HTML <br/> or
sublabels) so the diagram content and edge labels match the original ASCII
diagram.

---

Nitpick comments:
In `@docs/DEPLOYMENT.md`:
- Line 8: The three consecutive sentences starting "For architecture details,
...", "For development setup, ...", and "For a concise overview..." are
repetitive; rewrite that fragment so the three links are combined into a single
sentence (e.g., "See ARCHITECTURE.md for architecture details, CONTRIBUTING.md
for development setup, and the air-gapped section in README.md for offline
operation."), replacing the three "For ..." sentences with one concise,
comma-separated sentence while preserving each link and context.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a94d7af6-3689-4318-9b16-eea7ffa19b53

📥 Commits

Reviewing files that changed from the base of the PR and between b0c94ed and 1bd782c.

📒 Files selected for processing (2)

• README.md
• docs/DEPLOYMENT.md

[zhengluo-nv]

DCO check fails