Skip to content

The Open Source DocuSign Alternative.

chore: update document visibility tooltip (#3529)

roshboi734391d03217
diff --git a/apps/docs/content/docs/users/documents/advanced/document-visibility.mdx b/apps/docs/content/docs/users/documents/advanced/document-visibility.mdx
index 56b6eae9f..d5687da1d 100644
--- a/apps/docs/content/docs/users/documents/advanced/document-visibility.mdx
+++ b/apps/docs/content/docs/users/documents/advanced/document-visibility.mdx
@@ -18,8 +18,8 @@ In **Default Document Visibility** (under document preferences), you can choose:
<Tabs items={['Everyone', 'Managers and above', 'Admins only', 'Inherit']}>
<Tab value="Everyone">All team members can access and view the document.</Tab>
- <Tab value="Managers and above">Only managers and admins can access and view the document.</Tab>
- <Tab value="Admins only">Only admins can access and view the document.</Tab>
+ <Tab value="Managers and above">Only you, managers and admins can access and view the document.</Tab>
+ <Tab value="Admins only">Only you and admins can access and view the document.</Tab>
<Tab value="Inherit">Use the organisation's default. Available for team-level settings only.</Tab>
</Tabs>
@@ -67,6 +67,56 @@ The `document owner` (the user who created the document) always has access to th
The `recipient` (the user who receives the document for signature, approval, etc.) also has access to the document, regardless of the document's visibility settings. This means that even if a document is set to "Admins only", the recipient can still view and sign the document.
+## Examples
+
+Each example uses the same team: **Alice** (Admin), **Mark** (Manager), and three Members: **Mia**, **Sam**, and **Leo**. Select a visibility option to see who can access the document.
+
+<Tabs items={['Everyone', 'Managers and above', 'Admins only']}>
+<Tab value="Everyone">
+
+Sam uploads a document and sets visibility to **Everyone**.
+
+| Person | Role | <span className="block text-left w-full">Can view it?</span> | Why |
+| ------ | ------- | :-----------------------------------------------------------: | -------------------------------------- |
+| Alice | Admin | <Included /> | Everyone on the team can see it |
+| Mark | Manager | <Included /> | Everyone on the team can see it |
+| Mia | Member | <Included /> | Everyone on the team can see it |
+| Sam | Member | <Included /> | He created it, and everyone can see it |
+| Leo | Member | <Included /> | Everyone on the team can see it |
+
+</Tab>
+<Tab value="Managers and above">
+
+Mark creates a document, sets visibility to **Managers and above**, and adds Mia as a recipient.
+
+| Person | Role | <span className="block text-left w-full">Can view it?</span> | Why |
+| ------ | ------- | :-----------------------------------------------------------: | -------------------------------------------- |
+| Alice | Admin | <Included /> | Admins can see "Managers and above" documents |
+| Mark | Manager | <Included /> | He created it |
+| Mia | Member | <Included /> | She is a recipient, so her role doesn't matter |
+| Sam | Member | <NotIncluded /> | Members can't see it, and he isn't a recipient |
+| Leo | Member | <NotIncluded /> | Members can't see it, and he isn't a recipient |
+
+</Tab>
+<Tab value="Admins only">
+
+Mia creates a document and adds Leo as a recipient. The team's default visibility is **Admins only**.
+
+| Person | Role | <span className="block text-left w-full">Can view it?</span> | Why |
+| ------ | ------- | :-----------------------------------------------------------: | ----------------------------------------------- |
+| Alice | Admin | <Included /> | Admins can see every document |
+| Mark | Manager | <NotIncluded /> | Managers can't see "Admins only" documents |
+| Mia | Member | <Included /> | She created it, so her role doesn't matter |
+| Sam | Member | <NotIncluded /> | Members can't see it, and he isn't a recipient |
+| Leo | Member | <Included /> | He is a recipient, so his role doesn't matter |
+
+</Tab>
+</Tabs>
+
+<Callout type="tip">
+ **Need to send a private document?** Set document visibility to **Admins only**. Only you, assigned recipients, and team admins can access it.
+</Callout>
+
## See Also
- [Document Preferences](/docs/users/organisations/preferences/document) - Configure default document settings
diff --git a/apps/remix/app/components/general/envelope-editor/envelope-editor-settings-dialog.tsx b/apps/remix/app/components/general/envelope-editor/envelope-editor-settings-dialog.tsx
index 1abf0fa54..b0a3f2ec1 100644
--- a/apps/remix/app/components/general/envelope-editor/envelope-editor-settings-dialog.tsx
+++ b/apps/remix/app/components/general/envelope-editor/envelope-editor-settings-dialog.tsx
@@ -51,7 +51,15 @@ import {
DialogTitle,
DialogTrigger,
} from '@documenso/ui/primitives/dialog';
-import { Form, FormControl, FormField, FormItem, FormLabel, FormMessage } from '@documenso/ui/primitives/form/form';
+import {
+ Form,
+ FormControl,
+ FormDescription,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
+} from '@documenso/ui/primitives/form/form';
import { Input } from '@documenso/ui/primitives/input';
import { MultiSelectCombobox } from '@documenso/ui/primitives/multi-select-combobox';
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@documenso/ui/primitives/select';
@@ -943,6 +951,10 @@ export const EnvelopeEditorSettingsDialog = ({ trigger, ...props }: EnvelopeEdit
onValueChange={field.onChange}
/>
</FormControl>
+
+ <FormDescription>
+ <Trans>The document owner and assigned recipients will always have access.</Trans>
+ </FormDescription>
</FormItem>
)}
/>
diff --git a/packages/ui/components/document/document-visibility-select.tsx b/packages/ui/components/document/document-visibility-select.tsx
index 9449ad776..e1a65967c 100644
--- a/packages/ui/components/document/document-visibility-select.tsx
+++ b/packages/ui/components/document/document-visibility-select.tsx
@@ -62,26 +62,40 @@ export const DocumentVisibilityTooltip = () => {
</h2>
<p>
- <Trans>The visibility of the document to the recipient.</Trans>
+ <Trans>
+ Controls which team members can view and access this document. The document owner and assigned recipients
+ will always have access.
+ </Trans>
</p>
<ul className="ml-3.5 list-outside list-disc space-y-0.5 py-2">
<li>
<Trans>
- <strong>Everyone</strong> - Everyone can access and view the document
+ <strong>Everyone</strong> - Visible to you and all team members.
</Trans>
</li>
<li>
<Trans>
- <strong>Managers and above</strong> - Only managers and above can access and view the document
+ <strong>Managers and above</strong> - Visible to you and team managers and admins.
</Trans>
</li>
<li>
<Trans>
- <strong>Admins only</strong> - Only admins can access and view the document
+ <strong>Admins only</strong> - Visible to you and team admins.
</Trans>
</li>
</ul>
+
+ <p>
+ <a
+ href="https://docs.documenso.com/docs/users/documents/advanced/document-visibility#examples"
+ target="_blank"
+ rel="noreferrer"
+ className="text-documenso-700 hover:text-documenso-600 hover:underline"
+ >
+ <Trans>Examples</Trans>
+ </a>
+ </p>
</TooltipContent>
</Tooltip>
);
diff --git a/packages/ui/primitives/document-flow/add-settings.tsx b/packages/ui/primitives/document-flow/add-settings.tsx
index 641251edd..7a4512f5e 100644
--- a/packages/ui/primitives/document-flow/add-settings.tsx
+++ b/packages/ui/primitives/document-flow/add-settings.tsx
@@ -25,7 +25,15 @@ import {
DocumentVisibilityTooltip,
} from '@documenso/ui/components/document/document-visibility-select';
import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@documenso/ui/primitives/accordion';
-import { Form, FormControl, FormField, FormItem, FormLabel, FormMessage } from '@documenso/ui/primitives/form/form';
+import {
+ Form,
+ FormControl,
+ FormDescription,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
+} from '@documenso/ui/primitives/form/form';
import { MultiSelectCombobox } from '@documenso/ui/primitives/multi-select-combobox';
import { zodResolver } from '@hookform/resolvers/zod';
import { Trans, useLingui } from '@lingui/react/macro';
@@ -293,6 +301,10 @@ export const AddSettingsFormPartial = ({
}}
/>
</FormControl>
+
+ <FormDescription>
+ <Trans>The document owner and assigned recipients will always have access.</Trans>
+ </FormDescription>
</FormItem>
)}
/>
diff --git a/packages/ui/primitives/template-flow/add-template-settings.tsx b/packages/ui/primitives/template-flow/add-template-settings.tsx
index 94114df75..7aead120d 100644
--- a/packages/ui/primitives/template-flow/add-template-settings.tsx
+++ b/packages/ui/primitives/template-flow/add-template-settings.tsx
@@ -26,7 +26,15 @@ import {
} from '@documenso/ui/components/document/document-visibility-select';
import { TemplateTypeSelect, TemplateTypeTooltip } from '@documenso/ui/components/template/template-type-select';
import { Accordion, AccordionContent, AccordionItem, AccordionTrigger } from '@documenso/ui/primitives/accordion';
-import { Form, FormControl, FormField, FormItem, FormLabel, FormMessage } from '@documenso/ui/primitives/form/form';
+import {
+ Form,
+ FormControl,
+ FormDescription,
+ FormField,
+ FormItem,
+ FormLabel,
+ FormMessage,
+} from '@documenso/ui/primitives/form/form';
import { zodResolver } from '@hookform/resolvers/zod';
import { Trans, useLingui } from '@lingui/react/macro';
import {
@@ -293,6 +301,10 @@ export const AddTemplateSettingsFormPartial = ({
}}
/>
</FormControl>
+
+ <FormDescription>
+ <Trans>The document owner and assigned recipients will always have access.</Trans>
+ </FormDescription>
</FormItem>
)}
/>