Skip to content

docs(entrypoints): audit and fix top-level navigation, README, and getting-started - #1152

Merged
slin1237 merged 1 commit into
mainfrom
docs/audit-team-1-entrypoints
Apr 15, 2026
Merged

slin1237 merged 1 commit into
mainfrom
docs/audit-team-1-entrypoints

Conversation

@slin1237

@slin1237 slin1237 commented Apr 15, 2026 •

Copy link
Copy Markdown
Member

Description

Problem

Top-level entry points (README.md, docs/index.md, MkDocs nav,
getting-started) had drifted from the current codebase. Some CLI
flags in examples were fabricated (--ha-mesh --seeds — not a real
flag), engine image tags were a major version behind, and a doc
page (reference/mcp-internal-servers.md) existed but was orphaned
from the nav.

Solution

Systematic audit of 7 entry-point files against current source code
(main.rs, Cargo.toml, bindings/python/pyproject.toml,
.github/workflows/release-*.yml, bindings/python/src/smg/serve.py).
Writer phase produced a claim-by-claim audit with code citations;
Tech Lead phase independently re-verified every change.

Changes

  • Verified 59 claims across 7 doc files
  • Fixed 5 inaccuracies (mesh CLI flags, macOS wheels, TRT-LLM
    command, engine image tags, magiclink user)
  • Updated 2 outdated engine versions (sglang 0.5.10, vllm 0.19.0,
    trtllm 1.3.0rc10; tag prefix 1.3.3 → 1.4.1)
  • Documented 1 previously orphaned page in the MkDocs nav
    (reference/mcp-internal-servers.md)
  • Full audit report: docs/_audit/team-1.md

Out-of-scope findings (for follow-up)

The Writer flagged but did not touch: parse_policy in
model_gateway/src/main.rs:877-908 silently falls consistent_hashing
and bucket through to RoundRobin. This is a code-level CLI bug
discovered during the audit — tracked for a separate PR.

Test plan

  • Every fix cites a source code file:line reference
  • No source code modified (verified git diff origin/main -- '*.rs' 'Cargo*')
  • mkdocs build --strict --clean passes
  • Tech Lead independently verified every change against cited source
Checklist
  • Documentation updated
  • (Optional) Join #sig-smg on Slack to discuss

Summary by CodeRabbit

  • Documentation

    • Updated mesh configuration guidance with new command-line options
    • Refreshed getting-started examples with latest service versions (v1.4.1)
    • Expanded platform support information to include Intel and Apple Silicon
    • Added new reference documentation for internal MCP servers
  • Bug Fixes

    • Corrected TensorRT-LLM worker invocation example

@slin1237
slin1237 requested a review from CatherineSue as a code owner April 15, 2026 13:29
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 15, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request performs a documentation audit and update for the Shepherd Model Gateway (SMG). Key changes include correcting CLI flags in the README for high availability mesh, updating the getting started guide to reflect version 1.4.1 and support for Intel-based macOS wheels, and fixing an erroneous TensorRT-LLM command. Additionally, the mkdocs.yml configuration was updated to include missing navigation for internal MCP servers and to correct the repository organization name. I have no feedback to provide as there were no review comments.

@coderabbitai

coderabbitai Bot commented Apr 15, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6d6c8f3b-98dc-4576-b2f7-e9a714c91a8d

📥 Commits

Reviewing files that changed from the base of the PR and between dcfcbf5 and 3897064.

📒 Files selected for processing (3)
  • README.md
  • docs/getting-started/index.md
  • mkdocs.yml

📝 Walkthrough

Walkthrough

Documentation and configuration updates across README, getting-started guide, and mkdocs configuration. Includes CLI mesh flag changes, Docker image tag version bumps to v1.4.1, macOS platform support clarification, and mkdocs navigation additions.

Changes

Cohort / File(s) Summary
CLI & Getting Started Docs
README.md, docs/getting-started/index.md
Updated mesh CLI configuration from --ha-mesh and --seeds to --enable-mesh, --mesh-advertise-host, and --mesh-peer-urls. Bumped Docker image tags from v1.3.x to v1.4.1 for SGLang, vLLM, and TensorRT-LLM. Updated macOS support from "Apple Silicon" to "Intel and Apple Silicon". Fixed TensorRT-LLM command by removing duplicate serve argument.
Site Configuration
mkdocs.yml
Updated pymdownx.magiclink user configuration from your-org to lightseekorg. Added navigation entry for "Internal MCP Servers" documentation page.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • #786 — Updates mesh/HA CLI configuration documentation with standardized flags like --enable-mesh and --mesh-peer-urls.
  • #848 — Updates docs/getting-started/index.md with Docker image tags and CLI descriptions.
  • #858 — Updates getting-started documentation with Docker and engine image tag references.

Suggested reviewers

  • CatherineSue
  • key4ng

Poem

🐰 Our docs hop forward with flags so new,
Mesh meshes mesh with configs true,
Tags bump to v1.4, bright and fleet,
Apple to Intel—platforms complete! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 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 changes: documentation updates to top-level entry points (README, navigation, and getting-started guide) with an audit focus.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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/audit-team-1-entrypoints

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

…tting-started

Systematic audit of entry-point documentation against the current
codebase. Writer phase performed inventory, verify, discover, and
fix; Tech Lead phase independently re-verified every change
against cited source code before shipping.

- 59 claims verified across 7 doc files
- 5 inaccuracies fixed (mesh CLI flags, version strings, engine image tags, TRT-LLM command, mkdocs nav, magiclink config)
- 2 outdated items updated (engine versions, image tag prefix)
- 1 previously orphaned doc restored to nav (mcp-internal-servers.md)

The audit worksheet is kept as worktree-local scratch and is not
committed to avoid polluting the rendered mkdocs site.

Refs: .claude/plans/2026-04-15-docs-audit-workflow.md (Team 1)
Signed-off-by: Simo Lin <linsimo.mark@gmail.com>
@slin1237
slin1237 force-pushed the docs/audit-team-1-entrypoints branch from dcfcbf5 to 3897064 Compare April 15, 2026 18:43
@slin1237
slin1237 merged commit 492dc84 into main Apr 15, 2026
34 checks passed
@slin1237
slin1237 deleted the docs/audit-team-1-entrypoints branch April 15, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant