Add initial share logs page (Significant-Gravitas#4965)

* Add initial share logs page * Fix title sizes * Update share_logs.md Added some text for reasons to share logs * Add section on how to share logs using e2b * Fix path to images with sizes * Fix paths to images in docs * Fix formatting * Fix formatting * Fix grammar * Make position in menu more prominent * original log directory was incorrect I took the directory from usage.md but that is incorrect * Updated the directory for the logs Updated the directory for the logs * added some text and made it pretty --------- Co-authored-by: NeonN3mesis <129052650+NeonN3mesis@users.noreply.github.com> Co-authored-by: Reinier van der Leer <github@pwuts.nl>
dayofthedave · Jul 17, 2023 · 1dcbc56 · 1dcbc56
1 parent a2826d5
commit 1dcbc56
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 3 deletions.
diff --git a/docs/imgs/e2b-dashboard.png b/docs/imgs/e2b-dashboard.png
diff --git a/docs/imgs/e2b-log-url.png b/docs/imgs/e2b-log-url.png
diff --git a/docs/imgs/e2b-new-tag.png b/docs/imgs/e2b-new-tag.png
diff --git a/docs/imgs/e2b-tag-button.png b/docs/imgs/e2b-tag-button.png
diff --git a/docs/share-your-logs.md b/docs/share-your-logs.md
@@ -0,0 +1,52 @@
+## Share your logs with us to help improve Auto-GPT
+
+Do you notice weird behavior with your agent? Do you have an interesting use case? Do you have a bug you want to report?
+Follow the steps below to enable your logs and upload them. You can include these logs when making an issue report or discussing an issue with us.
+
+### Enable Debug Logs
+Activity, Error, and Debug logs are located in `./logs`
+
+To print out debug logs:
+
+``` shell
+./run.sh --debug     # on Linux / macOS
+
+.\run.bat --debug    # on Windows
+
+docker-compose run --rm auto-gpt --debug    # in Docker
+```
+
+### Inspect and share logs
+You can inspect and share logs via [e2b](https://e2b.dev).
+![E2b logs dashboard](./imgs/e2b-dashboard.png)
+
+
+
+1. Go to [autogpt.e2b.dev](https://autogpt.e2b.dev) and sign in.
+2. You'll see logs from other members of the AutoGPT team that you can inspect.
+3. Or you upload your own logs. Click on the "Upload log folder" button and select the debug logs dir that you generated. Wait a 1-2 seconds and the page reloads.
+4. You can share logs via sharing the URL in your browser.
+![E2b log URL](./imgs/e2b-log-url.png)
+
+
+### Add tags to logs
+You can add custom tags to logs for other members of your team. This is useful if you want to indicate that the agent is for example having issues with challenges.
+
+E2b offers 3 types of severity:
+
+- Success
+- Warning
+- Error
+
+You can name your tag any way you want.
+
+#### How to add a tag
+1. Click on the "plus" button on the left from the logs folder name.
+
+![E2b tag button](./imgs/e2b-tag-button.png)
+
+2. Type the name of a new tag.
+
+3. Select the severity.
+
+![E2b new tag](./imgs/e2b-new-tag.png)
diff --git a/docs/usage.md b/docs/usage.md
@@ -89,12 +89,20 @@ This may give your bot increased intelligence.
 
 ## Logs
 
-Activity and error logs are located in the `./output/logs`
+Activity, Error, and Debug logs are located in `./logs`
+
+!!! tip 
+    Do you notice weird behavior with your agent? Do you have an interesting use case? Do you have a bug you want to report?
+    Follow the step below to enable your logs. You can include these logs when making an issue report or discussing an issue with us.
 
 To print out debug logs:
 
 ``` shell
-./run.sh --debug
+./run.sh --debug     # on Linux / macOS
+
+.\run.bat --debug    # on Windows
+
+docker-compose run --rm auto-gpt --debug    # in Docker
 ```
 
 ## Disabling Command Categories

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,7 +12,8 @@ nav:
     - Voice: configuration/voice.md
     - Image Generation: configuration/imagegen.md
 
-  - Contributing:
+  - Help us improve Auto-GPT:
+    - Share your debug logs with us: share-your-logs.md
     - Contribution guide: contributing.md
     - Running tests: testing.md
     - Code of Conduct: code-of-conduct.md