Merge branch 'main' into feature/ISS-78-create-docs

docs/configuring.md

@@ -7,40 +7,67 @@ sidebar_position: 3
 There are two approaches to configuring Pixeebot:
 
 1. **Target Repository Configuration:**
-Create a `pixeebot.yaml` file in the `.github` directory of the target repository. Configurations in the target repository will take precedence over other configurations.
+   Create a `pixeebot.yaml` file in the `.github` directory of the target repository. Configurations in the target repository will take precedence over other configurations.
 
 2. **Global Repository Configuration:**
-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.
+   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:
 
 ```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. 
 
 #### `allow_llm_access`
+
 Setting to `true` will enable Pixeebot to [send data to a LLM](faqs.md) while analyzing your code.
+
 > **Note** This is the default configuration upon installation.
 
-### `assignees`
-Setting this field tells Pixeebot which GitHub collaborators from the repository should be assigned when it sends pull requests to the main branch. The bot will randomly select from the list every time a pull request is issued.
+# Configuring Automatic Assignment
 
-**Note**
-* If no assignees are provided through this configuration, a collaborator may be assigned at random. 
-* If an assignee provided through this configuration is not a collaborator on the repository, a different collaborator may be assigned at random.
-
+To automatically assign reviewers to pixeebot PRs, consider [setting up a `CODEOWNERS` file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
+
+To automatically assign users to pixeebot PRs, consider creating a github action. Below is an example action that will assign all pixeebot PRs to the user octocat:
+
+```yaml
+on:
+  pull_request:
+    types: [opened, reopened, ready_for_review]
+
+jobs:
+  auto-assign:
+    runs-on: ubuntu-latest
+    if: github.actor == 'pixeebot[bot]'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Assign PR to Collaborators
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const collaborators = ['octocat']; // Replace with actual GitHub usernames
+            github.rest.issues.addAssignees({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              assignees: collaborators
+            })
+```
 
-To automatically assign reviewers to Pixeebot PRs, consider [setting up a `CODEOWNERS` file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
+Please contact us at [email protected] if you have any questions, or would like more options for automatic assignment.