Removed config content and added to user guide

pixee · Jan 25, 2024 · 8079368 · 8079368
1 parent 241c91a
commit 8079368
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/docs/configuring.md b/docs/configuring.md
@@ -13,21 +13,16 @@ Create a `pixeebot.yaml` file in the `.github` directory of the target repositor
 Alternatively, you can create the `pixeebot.yaml` file in the `.github` directory of your `.github` repository. This will serve as a global configuration that applies to multiple repositories.
 
 ## YAML
-A typical .yaml configuration file might look like this:
+A typical `.yaml` configuration file might look like this:
 
 ```yaml
-activity_dashboard: true
-
 ai:
   allow_llm_access: true
 
 assignees: [mary, luis]
 ```
 ## Properties
 
-### `activity_dashboard`
-The activity dashboard exists as a GitHub Issue and offers a holistic perspective on Pixeebot's functionality within your repository. Through this interface, you can conveniently monitor open pull requests, pending recommendations, and more. The dashboard is automatically triggered upon installation, provided that GitHub Issues are enabled for your repository. Setting to `false` will remove it from view. 
-
 ### `ai`
 Contains settings related to AI functionality. 
 

diff --git a/docs/using-pixeebot.md b/docs/using-pixeebot.md
@@ -2,7 +2,7 @@
 sidebar_position: 4
 ---
 
-# User Guide
+# User guide
 
 ## Continuous improvement
 
@@ -43,3 +43,8 @@ If Pixeebot does not have any recommendations, it will mark the check as Success
 > Note: Pixeebot will only run when the pull request is first opened. If subsequent commits are introduced, Pixeebot will not initiate another run and the check will disappear, as progress is linked to the initial commit.
 
 ![checks in progress](/img/checks_in_progress.png)
+
+## Pixeebot activity
+The Activity dashboard exists as a GitHub Issue and offers a holistic perspective on Pixeebot's functionality within your repository. Through this interface, you can conveniently monitor your open pull requests, other available recommendations, and more. The dashboard is automatically enabled upon installation, provided that GitHub Issues are also enabled for your repository. 
+
+The issue can remain open, and the data will automatically refresh with each Pixeebot analysis that occurs. If the issue is closed, the feature will be disabled and the data will become stale. Reopening it will reactivate the dashboard, and resume auto-updates when Pixeebot runs.