diff --git a/docs/dev.rst b/docs/dev.rst index d6d2851..9732df8 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -86,7 +86,10 @@ Finally, the platform can also be started back up with ``launch``. It will take Debugging with breakpoints -------------------------- -To debug a local edx-platform repository, add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name:: +To debug a local edx-platform repository, first, start development in detached mode (with ``-d``), add a `python breakpoint `__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name:: + + # Start in detached mode: + tutor dev start -d # Debugging LMS: tutor dev start lms