Skip to content

docs(setup): slim the Setup overview to the genuinely-invisible rules#1849

Merged
xuyushun441-sys merged 1 commit into
mainfrom
adr0046-setup-doc-slim
Jun 14, 2026
Merged

docs(setup): slim the Setup overview to the genuinely-invisible rules#1849
xuyushun441-sys merged 1 commit into
mainfrom
adr0046-setup-doc-slim

Conversation

@xuyushun441-sys

Copy link
Copy Markdown
Contributor

Why

Follow-up to #1848. On review, the seeded setup_overview mixed two things: a few genuinely-invisible rules (worth documenting) and generic concept-restatement (permission-set vs role definitions) that duplicates what the Setup UI's own Users/Roles/Permission-set screens already show — then deferred to the external site per section. The ADR-0046 principle is "document the invisible, not what the UI shows," so the generic half doesn't earn its place.

What

Trim setup_overview (EN + zh) to three short bullets the screens don't reveal:

  • a user is identity, not access (and deactivate ≠ delete);
  • permissions are additive (effective access = union of permission sets);
  • "can't see a record" is almost always sharing, not object permissions.

studio_overview is left as-is — its overlay/precedence rule is exactly the kind of invisible gotcha this format is for.

Content only, no behaviour change.

🤖 Generated with Claude Code

Cut textbook concept-restatement and the repeated external-docs links that
duplicated what the Setup UI already shows; keep the three rules the screens
don't reveal (identity≠access, additive permissions, sharing-not-permissions).
EN + zh. Content only.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jun 14, 2026 1:12pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling size/m and removed documentation Improvements or additions to documentation tooling labels Jun 14, 2026
@xuyushun441-sys
xuyushun441-sys merged commit 110a333 into main Jun 14, 2026
13 checks passed
@xuyushun441-sys
xuyushun441-sys deleted the adr0046-setup-doc-slim branch June 14, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants