Skip to content

docs: add a guide to configuring permissions - #1910

Open
joshunrau wants to merge 2 commits into
DouglasNeuroInformatics:mainfrom
joshunrau:docs/configure-permissions
Open

joshunrau wants to merge 2 commits into
DouglasNeuroInformatics:mainfrom
joshunrau:docs/configure-permissions

Conversation

@joshunrau

Copy link
Copy Markdown
Collaborator

Admins asking which permissions a page needs, the Data Hub especially, now have a guide that answers it, and agents no longer run the full pnpm check for changes it cannot reach.

Changes

  • A new guide, How to Configure Permissions, explains how base levels, permission sets and custom permissions combine, walks through granting each, and lists the permissions behind every navigation item and every Data Hub page and tab, with a worked example and the default grants of each role. The Security reference and the getting-started guide link to it.
  • finishing-changes now scopes the checks to what a diff can break: nothing for files no check reads (agent docs, editor config, READMEs), the pull request's CI run for workflow files, the outreach lint and build for /docs, /blog and apps/outreach, and pnpm lint with pnpm test:coverage for unit-test-only diffs. The root AGENTS.md rule defers to the skill.

Decisions

  • The Data Hub table documents what each page loads from the API, not only what makes its menu item appear, because the two differ: opening a subject also needs Read Instrument, and the Assignments tab needs Read Assignment. Documenting the menu gate alone would leave admins configuring users who then hit error pages.
  • /docs and /blog are not exempt from checks, since astro check in pnpm lint reads them; they run the outreach lint and build instead.

Risks

  • opening-pr still requires pnpm check: green in the PR body, so a scoped-down change still needs the full run before a PR. That skill is not changed here.

Notes

Every permission in the guide was read from apps/web/src/hooks/useNavItems.ts, the API's @RouteAccess declarations, the hooks each Data Hub route calls, and AbilityFactory. The outreach build renders the new page and the links to it.

Adversarial review

Reviewed at commit 71abd68. pnpm check: green.

Findings

CLEAN

Attestation

I, Claude Opus 5.5, attest that the review block above reports the adversarial review as it ran on the commit named, with every finding it returned.

🤖 Generated with Claude Code

joshunrau and others added 2 commits November 10, 2026 15:42
Explains how base levels, permission sets and custom permissions combine,
walks admins through granting each, and lists the permissions every page
needs, with the Data Hub broken down per tab. Linked from the Security
reference and the getting-started guide.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A diff confined to files no check reads, to the outreach site, or to unit
tests now runs only the checks that can reach it instead of the full
`pnpm check`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

1 participant