From e54b67033890420dd8a71141e68cb44d9ae9ab2f Mon Sep 17 00:00:00 2001
From: Danyal-Faheem <danyal.faheem@arbisoft.com>
Date: Wed, 13 Nov 2024 14:09:14 +0500
Subject: [PATCH] docs: update readme for attaching containers

---
 docs/dev.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/dev.rst b/docs/dev.rst
index 4d6c2249e2..3dc0fc66d9 100644
--- a/docs/dev.rst
+++ b/docs/dev.rst
@@ -84,6 +84,21 @@ Finally, the platform can also be started back up with ``launch``. It will take
 
   tutor dev launch --pullimages
 
+Debugging with breakpoints
+--------------------------
+
+To debug a local edx-platform repository, add a `python breakpoint <https://docs.python.org/3/library/functions.html#breakpoint>`__ with ``breakpoint()`` anywhere in the code. Then, start the container by running ``start -d`` followed by the service's name and attach to the container by running ``attach`` followed by the service's name::
+
+  # Debugging LMS:
+  tutor dev start -d lms
+  tutor dev attach lms
+
+  # Or, debugging CMS:
+  tutor dev start -d cms
+  tutor dev attach cms
+
+To detach from the container without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``.
+
 Running arbitrary commands
 --------------------------