Skip to content

Commit fa56117

Browse files
Clarify reader/writer role descriptions in docs (#4)
Update capabilities table in rbac.mdx and teams.mdx to specify that roles affect context index permissions, not plan access. Add note clarifying all team members can read and write plans regardless of role. Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Matt Dailey <matt@ref.tools>
1 parent 57cef21 commit fa56117

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

usage/rbac.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ Ref allows you to give different members of your team different capabilities, so
99

1010
| Role | Capabilities |
1111
| --- | --- |
12-
| Admin | Search resources, add content, invite members, manage billing |
13-
| Writer | Search resources and add to the index |
14-
| Reader | Search only |
12+
| Admin | Search context index, add content to index, invite members, manage billing |
13+
| Writer | Search context index and add content to index |
14+
| Reader | Search context index |
15+
16+
> All team members can read and write plans regardless of role. Reader and Writer roles only affect permissions for the shared context index (indexed repositories).
1517
1618
## Management
1719

1820
Roles can be managed from [ref.tools/team](https://ref.tools/team). Make sure that your team is selected in the workspace picker in the top-left of the page.
1921

2022
## How to only use public docs
2123

22-
Some teams use Ref to only search public documentation sources. The best way to manage this is have one user sign up as an `admin` and invite the rest of the users as `readers`. Then no one will be able to index private sources.
24+
Some teams use Ref to only search public documentation sources. The best way to manage this is have one user sign up as an `admin` and invite the rest of the users as `readers`. Then no one will be able to index private sources.

usage/teams.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ Manage the capabilities of different team members with role-based access control
2323

2424
| Role | Capabilities |
2525
| --- | --- |
26-
| Admin | Search resources, add content, invite members, manage billing |
27-
| Writer | Search resources and add to the index |
28-
| Reader | Search only |
26+
| Admin | Search context index, add content to index, invite members, manage billing |
27+
| Writer | Search context index and add content to index |
28+
| Reader | Search context index |
29+
30+
> All team members can read and write plans regardless of role. Reader and Writer roles only affect permissions for the shared context index (indexed repositories).
2931
3032
### 5. Unified billing
3133
Manage your team's bill from a single account.

0 commit comments

Comments
 (0)