Skip to content

Commit 71a316c

Browse files
waleedlatif1waleedlatif1
committed
improvement(docs): reduce callout and FAQ overuse in enterprise docs
1 parent cabe1fa commit 71a316c

6 files changed

Lines changed: 10 additions & 71 deletions

File tree

‎apps/docs/content/docs/en/enterprise/access-control.mdx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Access Control
33
description: Restrict which models, blocks, and platform features each group of users can access
44
---
55

6-
import { Callout } from 'fumadocs-ui/components/callout'
76
import { FAQ } from '@/components/ui/faq'
87
import { Image } from '@/components/ui/image'
98

@@ -54,11 +53,7 @@ Controls which workflow blocks members can place and execute.
5453
<Image src="/static/enterprise/access-control-blocks.png" alt="Blocks tab showing Core Blocks (Agent, API, Condition, Function, Knowledge, etc.) and Tools (integrations like 1Password, A2A, Ahrefs, Airtable, and more) with checkboxes to allow or restrict each" width={900} height={500} /> Blocks are split into two sections: **Core Blocks** (Agent, API, Condition, Function, etc.) and **Tools** (all integration blocks).
5554

5655
- **All checked (default):** All blocks are allowed.
57-
- **Subset checked:** Only the selected blocks are allowed. Workflows that already contain a disallowed block will fail when run — they are not automatically modified.
58-
59-
<Callout type="info">
60-
The `start_trigger` block (the entry point of every workflow) is always allowed and cannot be restricted.
61-
</Callout>
56+
- **Subset checked:** Only the selected blocks are allowed. Workflows that already contain a disallowed block will fail when run — they are not automatically modified. The `start_trigger` block (the entry point of every workflow) is always allowed and cannot be restricted.
6257

6358
#### Platform
6459

‎apps/docs/content/docs/en/enterprise/audit-logs.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Audit Logs
33
description: Track every action taken across your organization's workspaces
44
---
55

6-
import { Callout } from 'fumadocs-ui/components/callout'
76
import { FAQ } from '@/components/ui/faq'
87
import { Image } from '@/components/ui/image'
98

@@ -78,9 +77,7 @@ Authorization: Bearer <api-key>
7877

7978
Paginate by passing the `nextCursor` value as the `cursor` parameter in the next request. When `nextCursor` is absent, you have reached the last page.
8079

81-
<Callout type="info">
82-
The API accepts both personal and workspace-scoped API keys. Rate limits apply — the response includes `X-RateLimit-*` headers with your current limit and remaining quota.
83-
</Callout>
80+
The API accepts both personal and workspace-scoped API keys. Rate limits apply — the response includes `X-RateLimit-*` headers with your current limit and remaining quota.
8481

8582
---
8683

‎apps/docs/content/docs/en/enterprise/data-retention.mdx‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Data Retention
33
description: Control how long execution logs, deleted resources, and copilot data are kept before permanent deletion
44
---
55

6-
import { Callout } from 'fumadocs-ui/components/callout'
76
import { FAQ } from '@/components/ui/faq'
87
import { Image } from '@/components/ui/image'
98

@@ -55,9 +54,7 @@ Controls how long **Mothership data** is kept, including:
5554
- Run checkpoints and async tool calls
5655
- Inbox tasks (Sim Mailer)
5756

58-
<Callout type="info">
59-
Each setting is independent. You can configure a short log retention period alongside a long soft deletion cleanup period, or set any combination that fits your compliance requirements.
60-
</Callout>
57+
Each setting is independent. You can configure a short log retention period alongside a long soft deletion cleanup period, or any combination that fits your compliance requirements.
6158

6259
---
6360

@@ -69,11 +66,7 @@ Retention is configured at the **workspace level**, not organization-wide. Each
6966

7067
## Defaults
7168

72-
By default, all three settings are unconfigured — no data is automatically deleted in any category until you configure it.
73-
74-
<Callout type="info">
75-
Setting a period to **Forever** explicitly keeps data indefinitely. Leaving a setting unconfigured has the same effect, but setting it to Forever makes the intent explicit and allows you to change it later without needing to save from scratch.
76-
</Callout>
69+
By default, all three settings are unconfigured — no data is automatically deleted in any category until you configure it. Setting a period to **Forever** has the same effect as leaving it unconfigured, but makes the intent explicit and allows you to change it later without saving from scratch.
7770

7871
---
7972

‎apps/docs/content/docs/en/enterprise/index.mdx‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: Enterprise
33
description: Enterprise features for business organizations
44
---
55

6-
import { Callout } from 'fumadocs-ui/components/callout'
7-
import { FAQ } from '@/components/ui/faq'
8-
96
Sim Enterprise provides advanced features for organizations with enhanced security, compliance, and management requirements.
107

118
---
@@ -26,9 +23,7 @@ Define permission groups on a workspace to control what features and integration
2623
2. Create a permission group with your desired restrictions
2724
3. Add workspace members to the permission group
2825

29-
<Callout type="info">
30-
Any workspace admin on an Enterprise-entitled workspace can manage permission groups. Users not assigned to any group have full access. Permission restrictions are enforced at both UI and execution time, and apply to workflows based on the workflow's workspace.
31-
</Callout>
26+
Any workspace admin on an Enterprise-entitled workspace can manage permission groups. Users not assigned to any group have full access. Restrictions are enforced at both UI and execution time, based on the workflow's workspace.
3227

3328
See the [Access Control guide](/docs/enterprise/access-control) for full details.
3429

@@ -60,14 +55,6 @@ Configure how long execution logs, soft-deleted resources, and Mothership data a
6055

6156
---
6257

63-
<FAQ items={[
64-
{ question: "Who can manage Enterprise features?", answer: "Workspace admins on an Enterprise-entitled workspace. Access Control, SSO, whitelabeling, audit logs, and data retention are all configured per workspace under Settings → Enterprise." },
65-
{ question: "Which SSO providers are supported?", answer: "Sim supports SAML 2.0 and OIDC, which works with virtually any enterprise identity provider including Okta, Azure AD (Entra ID), Google Workspace, ADFS, and OneLogin." },
66-
{ question: "How do access control permission groups work?", answer: "Permission groups are created per workspace and let you restrict which AI providers, workflow blocks, and platform features are available to specific members of that workspace. Each user can belong to at most one group per workspace. Users not assigned to any group have full access. Restrictions are enforced at both the UI level and at execution time based on the workflow's workspace." },
67-
]} />
68-
69-
---
70-
7158
## Self-hosted setup
7259

7360
Self-hosted deployments enable enterprise features via environment variables instead of billing.

‎apps/docs/content/docs/en/enterprise/sso.mdx‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,7 @@ Click **Save**. To test, sign out and use the **Sign in with SSO** button on the
107107
| Client ID | From Okta app |
108108
| Client Secret | From Okta app |
109109

110-
<Callout type="info">
111-
The issuer URL uses Okta's default authorization server (`/oauth2/default`), which is pre-configured on every Okta org. If you created a custom authorization server, replace `default` with your server name.
112-
</Callout>
110+
The issuer URL uses Okta's default authorization server, which is pre-configured on every Okta org. If you created a custom authorization server, replace `default` with your server name.
113111

114112
</Tab>
115113

@@ -138,10 +136,6 @@ Click **Save**. To test, sign out and use the **Sign in with SSO** button on the
138136
| Client ID | Application (client) ID |
139137
| Client Secret | Secret value |
140138

141-
<Callout type="info">
142-
Replace `{tenant-id}` with your Directory (tenant) ID from the app's Overview page. Sim auto-discovers token and JWKS endpoints from the issuer.
143-
</Callout>
144-
145139
</Tab>
146140

147141
<Tab value="Google Workspace">
@@ -225,11 +219,7 @@ Once SSO is configured, users with your domain (`company.com`) can sign in throu
225219
4. After authenticating, they are returned to Sim and added to your organization automatically
226220
5. They land in the workspace
227221

228-
Users who sign in via SSO for the first time are automatically provisioned and added to your organization — no manual invite required.
229-
230-
<Callout type="info">
231-
Password-based login remains available. Forcing all organization members to use SSO exclusively is not yet supported.
232-
</Callout>
222+
Users who sign in via SSO for the first time are automatically provisioned and added to your organization — no manual invite required. Password-based login remains available; forcing all organization members to use SSO exclusively is not yet supported.
233223

234224
---
235225

‎apps/docs/content/docs/en/enterprise/whitelabeling.mdx‎

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Whitelabeling
33
description: Replace Sim branding with your own logo, colors, and links
44
---
55

6-
import { Callout } from 'fumadocs-ui/components/callout'
7-
import { FAQ } from '@/components/ui/faq'
86
import { Image } from '@/components/ui/image'
97

108
Whitelabeling lets you replace Sim's default branding — logo, colors, and support links — with your own. Members of your organization see your brand instead of Sim's throughout the workspace.
@@ -13,6 +11,8 @@ Whitelabeling lets you replace Sim's default branding — logo, colors, and supp
1311

1412
## Setup
1513

14+
Organization owners and admins on an Enterprise-entitled workspace can configure whitelabeling.
15+
1616
### 1. Open Whitelabeling settings
1717

1818
Go to **Settings → Enterprise → Whitelabeling** in your workspace.
@@ -65,30 +65,7 @@ Whitelabeling replaces the following visual elements:
6565
- **Primary and accent colors** — applied to buttons, active states, and highlights
6666
- **Support and legal links** — help prompts and footer links point to your URLs
6767

68-
<Callout type="info">
69-
Whitelabeling applies only to members of your organization. Public-facing pages (login, marketing) are not affected.
70-
</Callout>
71-
72-
---
73-
74-
<FAQ items={[
75-
{
76-
question: "Who can configure whitelabeling?",
77-
answer: "Organization owners and admins can configure whitelabeling. On Sim Cloud, you must be on the Enterprise plan."
78-
},
79-
{
80-
question: "What image formats are supported?",
81-
answer: "PNG, JPEG, SVG, and WebP. Maximum file size is 5 MB for both the logo and wordmark."
82-
},
83-
{
84-
question: "What is the difference between the logo and the wordmark?",
85-
answer: "The logo is a square image shown in the collapsed sidebar. The wordmark is a wide image shown in the expanded sidebar alongside member names and navigation items."
86-
},
87-
{
88-
question: "Do members outside my organization see the custom branding?",
89-
answer: "No. Custom branding is scoped to your organization. Members see your branding when signed in to your organization's workspace."
90-
}
91-
]} />
68+
Whitelabeling applies only to members of your organization. Public-facing pages (login, marketing) are not affected.
9269

9370
---
9471

0 commit comments

Comments
 (0)