diff --git a/docs/.gitbook/assets/circles-profile-wallet-address.png b/docs/.gitbook/assets/circles-profile-wallet-address.png new file mode 100644 index 0000000..38b1fc1 Binary files /dev/null and b/docs/.gitbook/assets/circles-profile-wallet-address.png differ diff --git a/docs/.gitbook/assets/group-checker-owner-safe.png b/docs/.gitbook/assets/group-checker-owner-safe.png new file mode 100644 index 0000000..5ccaa7c Binary files /dev/null and b/docs/.gitbook/assets/group-checker-owner-safe.png differ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 24c0d25..97628f5 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -59,3 +59,10 @@ * [Glossary](developer-support/glossary.md) * [Circles Tools](developer-support/circles-tools.md) * [Past Hackathon Projects on Circles](developer-support/past-hackathon-projects-on-circles.md) + +## User Guides + +* [Circles Groups](user-guides/circles-groups/README.md) + * [Create a Circles Group](user-guides/circles-groups/create-a-circles-group-using-circles-core-app.md) + * [Migrate your group and update its details](user-guides/circles-groups/migrate-group-and-update-details.md) + * [Technical Group Details](user-guides/circles-groups/technical-group-details.md) diff --git a/docs/user-guides/circles-groups/migrate-group-and-update-details.md b/docs/user-guides/circles-groups/migrate-group-and-update-details.md new file mode 100644 index 0000000..8b1d3ba --- /dev/null +++ b/docs/user-guides/circles-groups/migrate-group-and-update-details.md @@ -0,0 +1,85 @@ +--- +icon: user-gear +description: >- + How to migrate your group so you can edit it, and how to fill in the new + group contract properties as an admin. +--- + +# Migrate your group and update its details + +New properties have been added to the group contract, and group admins need to fill them in. This guide walks you through making your Circles profile an admin of the group and then updating the new fields in the admin app. + +The process is straightforward: you add your Circles profile as a signer of the group's owner Safe, then use that connection to edit the group in the admin app. + +### Assumptions + +Before you start, this guide assumes the following: + +* You set up your account using [app.aboutcircles.com](https://app.aboutcircles.com). This means you have a signer and a wallet you can connect to that app to modify your account. +* Your group is owned by a Safe (multisig) that you control. +* You have a Circles profile and are willing to use it as an admin of the group. + +### Which steps apply to you? + +* If you created your group using [app.aboutcircles.com](https://app.aboutcircles.com), start at **Step 1**. +* If you created your group using [circles.gnosis.io/admin/circles-groups](https://circles.gnosis.io/admin/circles-groups), skip to **Step 6**. + +## Part 1 — Make your Circles profile an admin of the group + +### Step 1: Find your group + +Open the Group Checker and locate your group: + +{% embed url="https://aboutcircles.github.io/CirclesTools/groupChecker.html" %} + +### Step 2: Open the owner Safe + +In the **Owner** column, find the owner Safe of your group and click the wallet symbol next to it to open it in the Safe UI. + +

The Owner column in the Group Checker. Click the wallet symbol to open the owner Safe.

+ +### Step 3: Connect to the Safe UI + +Connect to the Safe UI using your owner EOA — the wallet that owns the Safe. + +### Step 4: Find your Circles profile address + +Locate the address of your personal Circles profile (for example, via the Gnosis App). + +

In the Gnosis App, open the QR code panel and copy your wallet address from the Advanced section.

+ +### Step 5: Add your Circles address as a signer + +In the Safe UI, go to **Settings → Manage Signers** and add your Circles address as a signer. Then sign the transaction. + +{% hint style="info" %} +Once the transaction is confirmed, your Circles profile is an authorised admin of the group's owner Safe and you can use it to edit the group. +{% endhint %} + +## Part 2 — Update the group details + +### Step 6: Sign in to the admin app + +Go to [circles.gnosis.io/admin/circles-groups](https://circles.gnosis.io/admin/circles-groups) and sign in using your passkey for the Gnosis App. + +### Step 7: Open your group + +Open your group and select **Edit Details**. + +### Step 8: Edit the details + +Fill in the new fields: + +* **Description** — Explain the purpose of the group and the benefits of joining. +* **Group type** — Set this to **closed**. +* **Contact details** — Provide a way for prospective members to reach you. +* **Membership Fee** and **Minimum Rep Score** — Optional. +* **Additional Criteria** — A brief description of how a user can join the group. + +### Step 9: Save + +Click **Save** to apply your changes. + +{% hint style="success" %} +That's it — your group details are now updated. +{% endhint %}