Skip to content

docs: compare registered and imported group control - #71

Merged
aspiers merged 5 commits into
mainfrom
docs/group-control-comparison
Jul 27, 2026
Merged

docs: compare registered and imported group control#71
aspiers merged 5 commits into
mainfrom
docs/group-control-comparison

Conversation

@aspiers

@aspiers aspiers commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Restructure Step 1 of the integration guide so registration and import are presented as equal alternatives, with their account-control implications explained before either procedure.

Changes

  • present group.register and group.import as Step 1a and Step 1b under a shared Step 1
  • add an upfront comparison of the starting account, email, primary password, CGS app password, recovery/rotation keys, and effective account-level control
  • distinguish the CGS owner governance role from control of the underlying PDS account
  • document the intended future transfer of full account control for registered groups, which could leave the owner in the same effective position as creating and importing the account themselves
  • clearly label that full account-control transfer as not yet supported

Testing

  • pnpm dlx prettier@3.8.1 --check docs/integration-guide.md
  • git diff --check

Tests were not run because this is a documentation-only change.

Summary by CodeRabbit

  • Documentation
    • Updated the integration guide with clearer guidance for setting up group accounts.
    • Added a comparison of registration and import options, including credential, recovery, and account-control considerations.
    • Clarified import parameters such as owner identity, email, and app password requirements.
    • Documented service authentication behavior and noted that importing does not modify the account’s DID document.

Explain how account-level control differs from CGS membership ownership. Document who retains the email, password, app password, and recovery key in each lifecycle path.

Co-authored-by: OpenAI Codex <noreply@openai.com>
@railway-app
railway-app Bot temporarily deployed to CGS / certified-group-service-pr-71 July 16, 2026 13:50 Destroyed
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1009ed56-5911-43a6-93c9-8d6861ab1180

📥 Commits

Reviewing files that changed from the base of the PR and between 23f02e9 and edb9e4a.

📒 Files selected for processing (1)
  • docs/integration-guide.md

📝 Walkthrough

Walkthrough

The integration guide replaces generic group registration guidance with a register-versus-import account setup model, clarifies import parameters and authentication details, and documents ownerDid validation and DID document behavior.

Changes

Group account documentation

Layer / File(s) Summary
Account setup and import guidance
docs/integration-guide.md
Step 1 now compares group.register and group.import; import guidance defines ownerDid, email, appPassword, and account-control behavior, including DID document handling.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation change: comparing control between registered and imported group accounts.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/group-control-comparison

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Present register and import as equal Step 1a/1b paths after an upfront comparison. Clarify that full account-control transfer for registered groups is intended but not yet supported.

Co-authored-by: OpenAI Codex <noreply@openai.com>
@railway-app
railway-app Bot temporarily deployed to CGS / certified-group-service-pr-71 July 16, 2026 13:54 Destroyed
@aspiers aspiers changed the title docs: compare control of registered and imported groups docs: compare registered and imported group control Jul 16, 2026
Avoid implying that registration or import permanently fixes who controls the underlying account.

Co-authored-by: OpenAI Codex <noreply@openai.com>
@railway-app
railway-app Bot temporarily deployed to CGS / certified-group-service-pr-71 July 16, 2026 13:59 Destroyed
Describe Step 1 as the complete group-account setup process encompassing both alternatives.

Co-authored-by: OpenAI Codex <noreply@openai.com>
@railway-app
railway-app Bot temporarily deployed to CGS / certified-group-service-pr-71 July 16, 2026 13:59 Destroyed
Name the specific account-control model instead of referring ambiguously to an end state.

Co-authored-by: OpenAI Codex <noreply@openai.com>
@railway-app
railway-app Bot temporarily deployed to CGS / certified-group-service-pr-71 July 16, 2026 14:02 Destroyed
@aspiers
aspiers marked this pull request as ready for review July 16, 2026 14:09
Copilot AI review requested due to automatic review settings July 16, 2026 14:09

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@railway-app

railway-app Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

🚅 Deployed to the certified-group-service-pr-71 environment in CGS

Service Status Web Updated (UTC)
certified-group-service ✅ Success (View Logs) Web Jul 16, 2026 at 2:03 pm
CGS demo app ✅ Success (View Logs) Web Jul 16, 2026 at 2:03 pm

@aspiers
aspiers requested a review from daviddao July 16, 2026 14:27
@aspiers
aspiers merged commit 56cc554 into main Jul 27, 2026
12 checks passed
@aspiers
aspiers deleted the docs/group-control-comparison branch July 27, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants