Repository navigation
docs(entrypoints): audit and fix top-level navigation, README, and getting-started - #1152
Conversation
There was a problem hiding this comment.
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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…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>
dcfcbf5 to
3897064
Compare
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 realflag), engine image tags were a major version behind, and a doc
page (
reference/mcp-internal-servers.md) existed but was orphanedfrom 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
command, engine image tags, magiclink user)
trtllm 1.3.0rc10; tag prefix 1.3.3 → 1.4.1)
(
reference/mcp-internal-servers.md)docs/_audit/team-1.mdOut-of-scope findings (for follow-up)
The Writer flagged but did not touch:
parse_policyinmodel_gateway/src/main.rs:877-908silently fallsconsistent_hashingand
bucketthrough toRoundRobin. This is a code-level CLI bugdiscovered during the audit — tracked for a separate PR.
Test plan
git diff origin/main -- '*.rs' 'Cargo*')mkdocs build --strict --cleanpassesChecklist
#sig-smgon Slack to discussSummary by CodeRabbit
Documentation
Bug Fixes