Skip to content

Change availability status of enterprise features#637

Merged
NiamhRelevance merged 1 commit into
mainfrom
s3-event-streaming-update
May 22, 2026
Merged

Change availability status of enterprise features#637
NiamhRelevance merged 1 commit into
mainfrom
s3-event-streaming-update

Conversation

@jordanc-relevanceai
Copy link
Copy Markdown
Collaborator

Updates availability of Directory Sync & Groups and S3 Event Streaming features as per internal request.

@jordanc-relevanceai jordanc-relevanceai self-assigned this May 22, 2026
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
relevanceai 🟢 Ready View Preview May 22, 2026, 2:33 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Three banned words (effortlessly, leverage/leverages ×2); two Step titles use (Optional) with capital O; five callout blocks contain bold labels (**Feature Status**, **Need help?**) which CLAUDE.md forbids
🟡 Technical clarity 7/10 Three Feature Status Info callouts carry stale dates ("full rollout by November 20, 2025") that directly contradict the page's own rollout timeline table — readers get wrong availability info
🟡 Non-technical clarity 8/10 "Why this matters" framing and time estimates are genuinely useful; bold text used as sub-section headers throughout the Best practices tabs makes tab content harder to scan
🟡 Structure 7/10 Bold text misused as section headers across all six Best practices tabs (systemic); callout bold-label violations affect visual hierarchy

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

Overall vibe: Solid bones — the step-by-step framing with time estimates, "why this matters" copy, and the rollout timeline table are all genuinely useful for an enterprise audience. The main things holding it back are: stale Feature Status callouts that now contradict the page's own rollout table (all the "by November 20, 2025" dates are six months past), three banned words in the best practices tabs, and bold text doing the job of #### headings throughout the entire Best practices section.

🔧 Issues (9)
  • enterprise/quick-start-guide.mdx:296 — "scales effortlessly as your organization grows" → effortlessly is a banned word; rewrite: "scales as your organization grows" or "scales without manual effort"
  • enterprise/quick-start-guide.mdx:298**Leverage existing structure**leverage is a banned word; rewrite heading as #### Use your existing structure
  • enterprise/quick-start-guide.mdx:304 — "This approach leverages the organizational structure" → leverages is a banned word; rewrite: "This approach uses the organizational structure"
  • enterprise/quick-start-guide.mdx:212<Step title="Enable User Level Authentication (Optional)"> → sentence case: (optional) not (Optional)
  • enterprise/quick-start-guide.mdx:225<Step title="Enable Visual Data Masking on sensitive agents (Optional)"> → sentence case: (optional) not (Optional)
  • enterprise/quick-start-guide.mdx:98–100<Info>**Feature Status**: Directory Sync & RBAC Groups are in Beta…</Info> — CLAUDE.md: callouts must not contain bold labels. Move **Feature Status**: outside the callout or rewrite as plain prose. Same pattern at lines 157–159, 205–207, 235–237.
  • enterprise/quick-start-guide.mdx:452–454<Note>**Need help?** Enterprise customers…</Note> — bold label inside callout; rewrite as plain paragraph or drop the label.
🧩 Component suggestions (2)
  • enterprise/quick-start-guide.mdx:280–291, 298–309, 317–326, 333–344, 352–361, 370–380 — Bold text (**Initial security setup**, **Leverage existing structure**, **Start restrictive, expand as needed**, etc.) is used as sub-section headers throughout all six Best practices tabs. CLAUDE.md says: "Don't mix bold text with heading formats for section titles — use a proper heading." Replace every bold-label-as-header with a #### heading. There are roughly 18 instances across the six tabs.

  • enterprise/quick-start-guide.mdx:44,47 — The "What you'll set up" cards use title case for two entries ("User Level Authentication", "Visual Data Masking") while the other nine cards use sentence case ("Directory sync & groups", "Data retention", etc.). If these are product feature names, apply the capitalization consistently in both the card and step titles (step titles already do this). If they are not product names, use sentence case: "User level authentication", "Visual data masking".

🏗️ Page structure (1)
  • enterprise/quick-start-guide.mdx:274–382 — The Best practices <Tabs> section uses bold paragraph text as visual section dividers within each tab, e.g., **Initial security setup** followed by a paragraph, then **Multi-factor authentication** followed by another paragraph. Each tab already opens with a ### heading. The bold labels should become #### headings so screen readers, search, and Mintlify's in-page TOC can pick them up. This affects all six tabs.
⚠️ Contradictions (3)
  • enterprise/quick-start-guide.mdx:99 says "Directory Sync & RBAC Groups are in Beta with full rollout by November 20, 2025"; the rollout timeline table on the same page at line 257 marks the feature as "✅ Available | Now". Today is May 22, 2026 — the inline callout is six months stale and directly contradicts the table below it. Delete or update the callout.

  • enterprise/quick-start-guide.mdx:158 says "S3 Event Streaming will be fully available by November 20, 2025, with self-serve setup by end of year"; the rollout timeline table at line 261 marks it as "✅ Available | Now". Same staleness issue — delete or update the callout, and the streaming-events.mdx page already contains full self-serve setup instructions confirming it is live.

  • enterprise/quick-start-guide.mdx:257 marks Directory Sync & Groups as "✅ Available | Now", but enterprise/rbac-groups.mdx:6–10 still carries a <Warning> that says "RBAC Groups is gradually being rolled out to our Enterprise customers." The two pages disagree on availability status. The rollout warning in rbac-groups.mdx should be removed or updated to match.

🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~910

Files read: enterprise/quick-start-guide.mdx (455 lines), enterprise/rbac-groups.mdx (328 lines), enterprise/streaming-events.mdx (569 lines — read as contradiction check for Step 6)

@NiamhRelevance NiamhRelevance merged commit 3cee52b into main May 22, 2026
6 checks passed
@NiamhRelevance NiamhRelevance deleted the s3-event-streaming-update branch May 22, 2026 03:00
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.

2 participants