docs: update how deploy util helper files are mentioned

[hhzhang16]

Overview:

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

• closes GitHub issue: #xxx

Summary by CodeRabbit

• Documentation
  • Updated pre-deployment profiling guide to use Python’s -m module mode for CLI utilities instead of calling script files directly.
  • Standardized examples for the manifest injector and PVC results download commands to improve consistency.
  • Clarified that command arguments and paths remain unchanged; only the invocation method differs.
  • Improved readability and reduced ambiguity around how to run the provided utilities.

[coderabbitai]

Walkthrough

Documentation updates change CLI invocation examples from direct script paths to Python module mode (-m), affecting manifest injection and PVC results download commands in docs/benchmarks/pre_deployment_profiling.md. No code logic or arguments changed.

Changes

Cohort / File(s)	Summary of Changes
Docs: CLI invocation updates docs/benchmarks/pre_deployment_profiling.md	Replaced script-based calls (e.g., python3 deploy/utils/inject_manifest.py, deploy/utils/download_pvc_results.py) with module-mode invocations (python3 -m deploy.utils.inject_manifest, python3 -m deploy.utils.inject_manifest.download_pvc_results). Arguments unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: update benchmarking and deploy utils #2933 — Also switches deploy utils to module-mode (python -m deploy.utils.inject_manifest / download_pvc_results), matching these documentation changes.

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description consists solely of the repository’s template headings and placeholder comments without any actual content describing the overview, specific changes, files to review, or a real issue number, making it impossible for reviewers to understand what has been done.	Please fill out the Overview section with a concise summary of the documentation updates, describe the precise edits under Details (for example, replacing direct script invocations with “python3 -m deploy.utils.inject_manifest” in docs/benchmarks/pre_deployment_profiling.md), list the files or sections reviewers should examine in “Where should the reviewer start?”, and replace the placeholder “#xxx” with the actual related issue number.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title “docs: update how deploy util helper files are mentioned” is concise and clearly summarizes the primary change, which is updating the documentation to reference CLI utilities via Python’s module mode. It focuses on the main change and uses a standard “docs:” prefix, making it clear to reviewers what area of the codebase is affected.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

A rabbit taps the terminal keys,
Swaps scripts for modules with gentle ease.
Dash-em calls hop down the trail,
Same paths, new coats, they shall not fail.
Docs refreshed—hip-hop, hooray!
Pip-pop, we ship the cleanest way. 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09c7b73 and 1028c29.

📒 Files selected for processing (1)

• docs/benchmarks/pre_deployment_profiling.md (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Test - dynamo

🔇 Additional comments (4)

docs/benchmarks/pre_deployment_profiling.md (4)

130-130: LGTM: consistent invocation via -m.

---

133-133: LGTM: custom config injection example reads well.

---

136-136: LGTM: PVC custom path example is consistent.

---

105-105: No issues with module mode; entrypoints present. Both inject_manifest.py and download_pvc_results.py declare if __name__ == "__main__": main(). Ensure you invoke python3 -m deploy.utils.inject_manifest from the repo root (or export PYTHONPATH).