Skip to content

Commit c8e5a56

Browse files
committed
docs(permissions): list the six module pages the landing index omitted (#10339)
`content/docs/permissions/meta.json` ships 21 pages; the "What's in this module" list in `index.mdx` named 14 of them. The six absent pages — system-context, delegated-administration, rls, attachments-access, access-matrix, explain — were routed and in the sidebar, and two were even described in the overview prose without a link, so nothing was unreachable. What was wrong is that the one list presenting itself as the module's index was a partial one with nothing marking it partial. Each new row is placed at its meta.json position rather than appended: the existing 14 were already exactly meta.json's order minus the six, so the order is derived, not invented. Link text is each page's own title (the card body's "Access Matrix" and "Explain" are slug prettifications; the pages are titled "Access-Matrix Snapshot Gate" and "Explain Engine"). Three of the six carry a gloss, matching the existing texture where a gloss is the exception reserved for a title that under-describes its page. Answers the card's option (b): the list stays hand-kept, with a comment naming meta.json as the source of truth and a one-line drift note. meta.json stores slugs only, so a derived list would have to synthesize link text from page frontmatter — which measurably regresses at least one existing row, and loses hand-written glosses that exist in no source file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DdCnBGcHeufjrq7drTD3wt
1 parent 53a48c9 commit c8e5a56

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

content/docs/permissions/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,28 @@ alike — is [Declaring Capabilities](/docs/permissions/capabilities).
6060

6161
## What's in this module
6262

63+
{/* Source of truth for this module's page set AND its order is meta.json in this directory — routing and the sidebar are built from it, and the list below mirrors it exactly, minus this page. */}
64+
{/* The list is hand-kept on purpose: meta.json stores slugs only, so the link text and the glosses below exist nowhere else, and a generated list would lose them. */}
65+
{/* Drift note: nothing checks the two against each other in either direction, so a page added to or removed from meta.json leaves this list silently stale — edit both in the same change. */}
66+
6367
- [Administrator Guide](/docs/permissions/administrator-guide) — the task-first manual for customer system administrators
6468
- [Authentication](/docs/permissions/authentication)
6569
- [Social & Enterprise SSO](/docs/permissions/sso)
6670
- [Authorization Architecture](/docs/permissions/authorization)
71+
- [System Context (`isSystem`)](/docs/permissions/system-context) — what the platform's one elevation flag short-circuits, and what it deliberately does not
6772
- [Profiles (removed)](/docs/permissions/profiles)
6873
- [Permission Sets](/docs/permissions/permission-sets)
6974
- [Positions](/docs/permissions/positions)
75+
- [Delegated Administration](/docs/permissions/delegated-administration)
7076
- [Sharing Rules](/docs/permissions/sharing-rules)
77+
- [Row-Level Security (RLS)](/docs/permissions/rls)
7178
- [Field-Level Security](/docs/permissions/field-level-security)
79+
- [Attachments Access](/docs/permissions/attachments-access)
7280
- [Permission Metadata](/docs/permissions/permission-metadata)
7381
- [Declaring Capabilities](/docs/permissions/capabilities) - the package author's half: `defineCapability`, and how `capabilities:` differs from `requires:`
7482
- [Security Permissions Matrix](/docs/permissions/permissions-matrix)
83+
- [Access-Matrix Snapshot Gate](/docs/permissions/access-matrix) — the committed (permission set × object) snapshot that makes every grant change a reviewable build event
84+
- [Explain Engine](/docs/permissions/explain) — ask the runtime why one decision came out the way it did, layer by layer
7585
- [Record-View Auditing](/docs/permissions/record-view-auditing) - who opened which record, and when
7686
- [Access Recipes](/docs/permissions/access-recipes)
7787

0 commit comments

Comments
 (0)