Add guide: Migrate your group and update its details#10
Conversation
Adds a step-by-step guide for group admins covering how to add their Circles profile as a signer on the owner Safe and how to fill in the new group contract properties via the admin app. https://claude.ai/code/session_01Dzge154ZrxRskefrJU726b
WalkthroughThis pull request adds a new migration guide for group avatars and registers it in the documentation table of contents. The guide walks group admins through two parts: making their Circles profile a signer of the group owner Safe via the Safe UI, and updating group details (description, type, contact info, fee criteria) in the admin app. ChangesGroup Avatar Migration Guide
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md (2)
43-43: 💤 Low valueConsider defining or linking the EOA acronym.
The term "owner EOA" is used without definition. Whilst "EOA" (Externally-Owned Account) may be familiar to blockchain developers, consider either defining it inline or linking to the glossary for clarity, especially since this guide targets group admins who may not be deeply technical.
✏️ Suggested clarification
-Connect to the Safe UI using your owner EOA — the wallet that owns the Safe. +Connect to the Safe UI using your owner EOA (externally-owned account) — the wallet that owns the Safe.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md` at line 43, The phrase "owner EOA" used in the sentence "Connect to the Safe UI using your owner EOA — the wallet that owns the Safe." is undefined; update the sentence to either expand EOA to "Externally-Owned Account (EOA)" on first mention or add a hyperlink to the glossary/definition, ensuring the phrase "owner EOA" is clearly described for non-technical readers so they understand it refers to the wallet that holds the Safe's ownership.
1-6: 💤 Low valueCheck icon choice for intended consistency —
migrate-group-and-update-details.mdusesicon: user-gearwhilegroup-avatars/README.mdusesicon: users-medical; however other pages in the samegroup-avatarsdirectory also use different icons (e.g.,people-group), so this may be intentional—confirm the design intent.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md` around lines 1 - 6, Confirm the intended icon for the group-avatars section, then update the frontmatter in migrate-group-and-update-details.md to use the chosen icon value consistently (replace icon: user-gear with the agreed icon, e.g., users-medical or people-group) so it matches other pages in the directory; if the variation is intentional, add a brief comment in the file or a note in the directory README stating why migrate-group-and-update-details.md uses a different icon.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md`:
- Line 14: The document drops from an H1 to a level-3 heading; change the
heading level for "Assumptions" from "### Assumptions" to "## Assumptions" (and
likewise convert any other level-3 headings immediately following the top-level
title to level-2) so headings increment by one level only and restore proper
document structure.
---
Nitpick comments:
In
`@docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md`:
- Line 43: The phrase "owner EOA" used in the sentence "Connect to the Safe UI
using your owner EOA — the wallet that owns the Safe." is undefined; update the
sentence to either expand EOA to "Externally-Owned Account (EOA)" on first
mention or add a hyperlink to the glossary/definition, ensuring the phrase
"owner EOA" is clearly described for non-technical readers so they understand it
refers to the wallet that holds the Safe's ownership.
- Around line 1-6: Confirm the intended icon for the group-avatars section, then
update the frontmatter in migrate-group-and-update-details.md to use the chosen
icon value consistently (replace icon: user-gear with the agreed icon, e.g.,
users-medical or people-group) so it matches other pages in the directory; if
the variation is intentional, add a brief comment in the file or a note in the
directory README stating why migrate-group-and-update-details.md uses a
different icon.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 04f8d688-22e5-4c82-b589-78bca61babae
📒 Files selected for processing (2)
docs/SUMMARY.mddocs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md
|
|
||
| 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 |
There was a problem hiding this comment.
Fix heading level structure.
The document jumps from a level-1 heading (line 8) to a level-3 heading here, skipping level 2. Markdown best practice requires headings to increment by only one level at a time for proper document structure, accessibility, and navigation.
📝 Proposed fix
Change the level-3 headings to level-2:
-### Assumptions
+## AssumptionsApply the same change to line 22:
-### Which steps apply to you?
+## Which steps apply to you?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Assumptions | |
| ## Assumptions |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 14-14: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.md`
at line 14, The document drops from an H1 to a level-3 heading; change the
heading level for "Assumptions" from "### Assumptions" to "## Assumptions" (and
likewise convert any other level-3 headings immediately following the top-level
title to level-2) so headings increment by one level only and restore proper
document structure.
Adds figure tags for the Group Checker owner-Safe screenshot (Step 2) and the Circles profile wallet address screenshot (Step 4), and removes the leftover TODO placeholder for Step 7. https://claude.ai/code/session_01Dzge154ZrxRskefrJU726b
Relocates the guide from circles-sdk/circles-avatars/group-avatars/ to user-guides/circles-groups/, positioned between Create a Circles Group and Technical Group Details. Updates image paths and adds a User Guides section to SUMMARY.md. https://claude.ai/code/session_01Dzge154ZrxRskefrJU726b
2 participants
Summary
Adds a new guide for group admins on how to migrate their group and fill in the new group contract properties via the admin app.
docs/circles-sdk/circles-avatars/group-avatars/migrate-group-and-update-details.mdSUMMARY.mdunder Group Avatars