Skip to content

docs: Add fine-grained access control documentation for entity/data tables (PR #14696)#620

Open
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1234/docs-update
Open

docs: Add fine-grained access control documentation for entity/data tables (PR #14696)#620
claude[bot] wants to merge 1 commit into
mainfrom
TSP-1234/docs-update

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Summary

  • Adds a new Data table permissions section to enterprise/rbac.mdx documenting the Admin/Operator/Viewer roles, private vs. open access modes, and how to grant permissions to individual users or groups
  • Updates the asset type definition in the asset-level controls section to include Data Table alongside Agent, Tool, Knowledge, and Workforce
  • Updates enterprise/rbac-groups.mdx to include data tables in the list of assets that support group-level permissions
  • Adds an access control callout to build/knowledge/create-knowledge.mdx with a link to the new RBAC section

Related

…tables

Documents the new Admin/Operator/Viewer permission system for data tables
(entity tables), including private vs. open access modes, per-user and
group permission grants, and the permissions matrix. Updates RBAC groups
reference and knowledge creation page to point to the new section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label May 12, 2026
@linear
Copy link
Copy Markdown

linear Bot commented May 12, 2026

TSP-1234

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 3 files (3 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🔴 Consistency 3/10 create-knowledge.mdx has title-case headings throughout (every H1–H3 violates sentence case). rbac-groups.mdx has title-case H2s, card titles, and accordion titles, plus the banned word "leveraging". rbac.mdx accordion titles use "powerful" (banned word) and several H2/H3 headings are title-cased.
🟡 Technical clarity 7/10 create-knowledge.mdx Related Features links use absolute URLs instead of root-relative paths. Nested numbered sub-steps (4→4.1, 4.2) may not render correctly in Mintlify.
🟡 Non-technical clarity 7/10 create-knowledge.mdx dives straight into "how to create" without a one-liner definition of what Knowledge is — the page title is just "Knowledge" and the description only says "Our RAG solution." Readers unfamiliar with the concept get no orientation before the steps begin.
🟡 Structure 6/10 All three files have callout violations: <Warning> and <Info> blocks with bold labels (**Important:**, **Note:**, **Best practice:**) and/or multi-paragraph content — both forbidden by CLAUDE.md. Sequential numbered procedures in create-knowledge.mdx should use <Steps> for visual progress indicators.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The content is accurate and well-organized — the RBAC permission tables are clear, the group sync workflow is well-explained, and the knowledge creation how-to covers all the right ground. But create-knowledge.mdx has title-case headings on virtually every section, and all three files have callout formatting violations that CLAUDE.md explicitly prohibits. Needs a capitalization sweep and callout cleanup before merging.

🔧 Issues (14)

Banned words

  • enterprise/rbac-groups.mdx:14 — "leveraging" → rewrite: "This feature simplifies user management for large teams by using your existing organizational structure from your identity provider."
  • enterprise/rbac.mdx:143 — Accordion title "More powerful than Viewer" → "powerful" is banned → rename to "How Chat compares to Viewer"
  • enterprise/rbac.mdx:147 — Accordion title "Less powerful than Member" → "powerful" is banned → rename to "How Chat compares to Member"

Heading/title sentence case — build/knowledge/create-knowledge.mdx
Every H1–H3 in this file is in title case. All of the following need sentence case (capitalize only proper nouns/product names: Knowledge, Agent, Agents):

  • line 7# Create and Organize Knowledge# Create and organize Knowledge
  • line 11## Creating Knowledge Sources## Creating knowledge sources
  • line 15### Manual Input### Manual input
  • line 29### Upload Documents### Upload documents
  • line 43### Extract Website Content### Extract website content
  • line 57### Connect Third-Party Integrations### Connect third-party integrations
  • line 68## Organizing Your Knowledge## Organizing your Knowledge
  • line 73### Structured Tables### Structured tables
  • line 81### Document Chunking### Document chunking
  • line 90### Knowledge Collections### Knowledge collections
  • line 99## Enhancing Knowledge Quality## Enhancing knowledge quality
  • line 103### Metadata Enrichment### Metadata enrichment
  • line 112### Knowledge Verification### Knowledge verification
  • line 121### Semantic Organization### Semantic organization
  • line 147## Advanced Knowledge Configuration## Advanced Knowledge configuration
  • line 151### Retrieval Settings### Retrieval settings
  • line 159### Knowledge Prioritization### Knowledge prioritization
  • line 168### Query Transformation### Query transformation
  • line 177## Best Practices for Knowledge Management## Best practices for Knowledge management
  • line 195## Related Features## Related features

Heading/title sentence case — enterprise/rbac-groups.mdx

  • line 43## Setting Up RBAC Groups## Setting up RBAC Groups
  • line 53## Organization-Level Groups## Organization-level groups
  • line 79## Project-Level Groups## Project-level groups
  • line 104## Asset-Level Groups## Asset-level groups
  • line 130## How Group Synchronization Works## How group synchronization works
  • line 146### New User Sign-Up Process### New user sign-up process
  • line 211## User Deprovisioning## User deprovisioning
  • line 228## Setting Up Directory Sync## Setting up directory sync
  • line 236### Setup Process### Setup process
  • line 265### Current Limitations### Current limitations
  • lines 19, 22, 25, 28, 31, 34 — Card titles inside <Columns> are all title-case: "Direct IDP Integration", "Bulk User Assignment", "Group-Level Permissions", "Automatic Synchronization", "Read-Only Groups", "Unified Interface" → sentence case each
  • lines 135, 138, 141 — Card titles in the sync <Columns>: "Hourly Sync", "New User Sign-Up", "Background Processing" → sentence case each
  • line 270 — Accordion title "Assigning Individual Roles to Group Members""Assigning individual roles to group members"
  • line 282 — Accordion title "Group Membership Visibility""Group membership visibility"
  • line 286 — Accordion title "Empty Agent Folders""Empty Agent folders" (Agent is a product term)
  • line 290 — Accordion title "Permission Downgrade""Permission downgrade"

Heading sentence case — enterprise/rbac.mdx

  • line 22## Best Practices## Best practices
  • line 26### Organization Level### Organization level
  • line 33### Project Level### Project level
  • line 43### Asset Level### Asset level
  • line 117### Chat Role Details### Chat role details
  • line 185## Workforce Permissions## Workforce permissions

Product term capitalization

  • enterprise/rbac-groups.mdx:108 — "agents, tools, knowledge bases, data tables, or workforces" → product features should be capitalized. enterprise/rbac.mdx:157 uses "Agent, Tool, Knowledge, Data Table, or Workforce" — match that style here.

Absolute URLs

  • build/knowledge/create-knowledge.mdx:197–199 — All three Related Features links use https://relevanceai.com/docs/... absolute URLs. CLAUDE.md requires root-relative paths: /build/knowledge/access-knowledge, /build/knowledge/enrich-with-tool, /build/knowledge/advanced-knowledge-retrieval.
🧩 Component suggestions (8)

Bold labels inside callouts (CLAUDE.md: callouts must be a single short paragraph — no bold labels inside)

  • enterprise/rbac-groups.mdx:182<Warning> opens with **Important**: bold label → remove the label; the warning reads fine without it.
  • enterprise/rbac-groups.mdx:224–226<Warning> contains **Best practice:** bold label → either remove the label or lift the best practice content into a <Tip> outside the warning so both points can breathe.
  • enterprise/rbac-groups.mdx:255–257<Warning> nested inside a <Step> has **Important for Microsoft Entra ID users:** bold label → remove the label (the warning is already scoped to Entra ID by context; if scope needs clarifying, make it the warning's first sentence without bold).
  • enterprise/rbac.mdx:204–206<Info> contains **Note:** bold label → change to <Note> and drop the label entirely.

Multi-paragraph callouts (CLAUDE.md: single short paragraph only)

  • enterprise/rbac-groups.mdx:6–10 — Opening <Warning> has two separate paragraphs. Condense to one sentence: "RBAC Groups is an Enterprise-only feature currently in gradual rollout — contact your sales representative if you don't have access yet."
  • enterprise/rbac.mdx:6–10 — Same two-paragraph <Warning> pattern. Same fix.

Sequential numbered lists → <Steps>

  • build/knowledge/create-knowledge.mdx:19–27, 31–39, 45–53 — The Manual Input, Upload Documents, and Extract Website Content sections each have 6–7 numbered steps representing sequential procedures. Wrap each in <Steps> to add visual progress indicators. (The Connect Third-Party Integrations section uses cards instead, which is correct.)
  • build/knowledge/create-knowledge.mdx:131–144 — "Connecting Knowledge to Agents" is a numbered list with a nested sub-list (4. → 4.1, 4.2). Nested numbered lists render inconsistently in Mintlify. Use <Steps> for the outer steps; for the two retrieval options, either use a nested <Steps> or present them as a small table (option name, description, best for).

<Columns> component verification

  • enterprise/rbac-groups.mdx:18–37, 134–144<Columns> with <Card> children is not seen elsewhere in this repo. Verify it renders as expected — if not, replace with <CardGroup cols={2}> which is the standard pattern here.
🏗️ Page structure (1)
  • build/knowledge/create-knowledge.mdx — The page dives straight into "Creating Knowledge Sources" without a one-line definition of what Knowledge is. The frontmatter description ("Our RAG solution") is minimal. Add 1–2 sentences at the top of the page body explaining what Knowledge is before the first ## section, so readers don't need to follow the cross-reference link just to orient themselves.
✅ Clean files (0)

All three files have issues.

🔋 Credit usage
Item Count
Files reviewed 3
Context pages read 2
Total lines processed ~675

Files read: build/knowledge/create-knowledge.mdx (199 lines), enterprise/rbac-groups.mdx (328 lines), enterprise/rbac.mdx (267 lines), enterprise/sso-setup.mdx (149 lines), build/knowledge/access-knowledge.mdx (30 lines)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants