Skip to content

docs: Refresh getting started docs#445

Draft
athreesh wants to merge 6 commits into
mainfrom
docs-refresh
Draft

docs: Refresh getting started docs#445
athreesh wants to merge 6 commits into
mainfrom
docs-refresh

Conversation

@athreesh

@athreesh athreesh commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds clearer README entry points with a crisp Start Here path for new users and links out to deeper docs.
  • Adds docs/COMPATIBILITY.md for support status and tested/runtime pins across ModelExpress, vLLM, Dynamo, SGLang, TRT-LLM, and platform dependencies.
  • Adds root AGENTS.md in a SGLang-style structure, focused on user-facing MX help: what MX does, how to route users by goal, deployment questions, metadata backend guidance, key env vars, and debugging playbooks.
  • Aligns Helm values, Helm docs, and public example manifests to the current 0.5.0 ModelExpress server image.
  • Fixes public-doc correctness issues: closes a broken deployment Markdown fence, removes internal Artifactory/runner details from deployment docs, replaces the broken DCO troubleshooting link, and removes a placeholder Helm repo URL.

Validation

  • git diff --check
  • Markdown fence scan across AGENTS/README/docs/examples/Helm docs
  • stale 0.3.0 reference scan across AGENTS, README, docs, helm, examples, .github, and ci
  • helm lint helm

Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@athreesh athreesh changed the title [codex] Refresh getting started docs docs: Refresh getting started docs Jun 23, 2026
@github-actions github-actions Bot added the docs label Jun 23, 2026
Updated the README to clarify ModelExpress capabilities and integration paths.

Signed-off-by: Anish <80174047+athreesh@users.noreply.github.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Signed-off-by: Anish Maddipoti <amaddipoti@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant