From 447cfafe83a883975af55ae8f2b6d85ff89c313f Mon Sep 17 00:00:00 2001
From: Douglas Jacobsen <dwjacobsen@google.com>
Date: Fri, 6 Oct 2023 11:34:56 -0600
Subject: [PATCH] Add debug info to docs, and docs link to readme

---
 README.md                           |  3 +++
 lib/ramble/docs/getting_started.rst | 14 ++++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 2a488a2e7..52e2fa8ee 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,9 @@ spack for some application definition. See
 Documentation
 ----------------
 
+Ramble’s documentation can be viewed at
+[https://googlecloudplatform.github.io/ramble/](https://googlecloudplatform.github.io/ramble/).
+
 For help with Ramble’s commands, run `ramble help` or `ramble help --all`.
 
 For more information on concepts in Ramble, see Ramble’s
diff --git a/lib/ramble/docs/getting_started.rst b/lib/ramble/docs/getting_started.rst
index 5ebfb3da6..da8d22846 100644
--- a/lib/ramble/docs/getting_started.rst
+++ b/lib/ramble/docs/getting_started.rst
@@ -124,6 +124,20 @@ For help with sub-commands, the ``-h`` flag can be used:
 
    $ ramble <subcommand> -h
 
+^^^^^^^^^^^^^^^^
+Debugging Ramble
+^^^^^^^^^^^^^^^^
+
+When an issue occurs while running Ramble, it can be useful to get additionally
+debugging information. To enable the debugging mode in Ramble, you can use the
+`-d` global option, as follows:
+
+.. code-block:: console
+
+    $ ramble -d <subcommand>
+    or;
+    $ ramble --debug <subcommand>
+
 ---------------------
 Defined Applications
 ---------------------