docs: add mermaid graph to .devcontainer/README.md, remove mount (revert).

[keivenchang]

Overview:

Remove mount. Add a Mermaid diagram to visualize the Dev Container architecture and workflow.

Details:

• Added comprehensive Mermaid diagram showing the complete Dev Container setup flow
• Visualized the relationship between IDE extensions (Remote-SSH and Dev Container)
• Illustrated volume mounts for project directory and HuggingFace cache
• Showed git config copy mechanism via Dev Container settings
• Depicted the Docker image to container relationship and ubuntu user context

Where should the reviewer start?

.devcontainer/README.md - Review the newly added Mermaid diagram at the top of the file to ensure it accurately represents the Dev Container architecture.

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

Summary by CodeRabbit

• Documentation
  • Added a visual Mermaid diagram explaining the end-to-end Dev Container workflow. It illustrates the developer IDE (VS Code/Cursor) connecting via Remote-SSH to a Linux workstation, the Docker container running as an ubuntu user, mounted volumes (project data, Hugging Face cache, etc.), gitconfig handling, and the action flow (open folder via SSH, IDE/shell via SSH + docker exec). Improves clarity for setup, volume mappings, and expected behavior.

[coderabbitai]

Walkthrough

Documentation update to .devcontainer/README.md adding a Mermaid diagram that visualizes the Dev Container workflow between a developer laptop, a Linux workstation, and a Docker container, including SSH interactions, mounted volumes, and gitconfig handling. No code or API changes.

Changes

Cohort / File(s)	Summary
Docs — Dev Container workflow diagram /.devcontainer/README.md	Added a Mermaid diagram depicting end-to-end Dev Container workflow (developer laptop, workstation host paths, Docker container/image, SSH flows, volume mounts, gitconfig copy, and styling).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• fix: small qol improvements to devcontainer #1427 — Also updates .devcontainer/README.md with Dev Container workflow documentation; overlaps in scope and file.

Poem

In a burrow of bytes I hop with glee,
Diagrams bloom like a digital tree.
SSH winds, volumes align,
Docker drums a steady design.
I twitch my whiskers—docs now clear,
Containers hum; the path is near. 🐇💻✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

.devcontainer/README.md (2)

26-26: Use official naming “Dev Containers” and standardize SSH capitalization

Minor wording/brand consistency improvements.

-            EXT["Dev Container Extension"]
+            EXT["Dev Containers Extension"]

-    EXT -->|"2. Dev Container:<br/>Open Folder (via ssh)"| IMAGE
+    EXT -->|"2. Dev Containers:<br/>Open Folder (via SSH)"| IMAGE

Also applies to: 51-51

---

49-50: Point SSH edges to the workstation host (not a specific directory) for accuracy

Arrows from Terminal and Remote-SSH to DIR suggest you SSH into a directory. More precise to target the host’s SSH service, then branch to directories/containers.

     subgraph WS["Linux Workstation"]
         DIR["~/dynamo<br/>(host directory)"]
         HFCACHE["~/.cache/huggingface<br/>(host cache)"]
         GITCONFIG["~/.gitconfig<br/>(host git config)"]
+        SSHD["sshd (Linux host)"]

-    TERM -->|"SSH Connection"| DIR
-    SSHEXT -->|"1. Remote-SSH"| DIR
+    TERM -->|"SSH connection"| SSHD
+    SSHEXT -->|"1. Remote - SSH"| SSHD
+    SSHD --> DIR

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7076990 and ff56cf9.

📒 Files selected for processing (1)

• .devcontainer/README.md (1 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). (2)

• GitHub Check: Mirror Repository to GitLab
• GitHub Check: Build and Test - dynamo

🔇 Additional comments (3)

.devcontainer/README.md (3)

22-70: Great addition: the Mermaid diagram meaningfully clarifies the devcontainer workflow

The overall structure, mounts, and the numbered flow make it much easier for newcomers to reason about the setup. Colors and subgraphs are also well used.

---

33-41: Confirm GitHub renders
line breaks as intended in labels

Mermaid generally supports
, but GitHub’s renderer can be picky. Quick preview in the PR helps avoid run-together labels.

Steps:

• Use “View file” in the PR and confirm the node labels for DIR/HFCACHE/CONTAINER/MOUNT show on multiple lines.
• If they don’t, replace
  with “\n” (Mermaid supports newline escapes in some labels) or split content across separate nodes.

---

37-37: Update README to match remoteUser and simplify wording

• File: .devcontainer/README.md
  Line: 37

-        subgraph CONTAINER["Docker Container<br/>vsc-dynamo-SHA-uid<br/>Running as: ubuntu user"]
+        subgraph CONTAINER["Docker Container<br/>vsc-dynamo-SHA-uid<br/>Running as: ubuntu"]

The remoteUser setting in .devcontainer/devcontainer.json is "ubuntu", so dropping “user” here keeps the README in sync.