chore: update documentation

This commit is contained in:
David Nguyen
2024-03-17 13:54:14 +08:00
parent 6781ff137e
commit dc8d8433dd
3 changed files with 37 additions and 24 deletions

View File

@ -5,17 +5,17 @@ import { motion } from 'framer-motion';
type AnimateGenericFadeInOutProps = {
children: React.ReactNode;
className?: string;
key?: string;
motionKey?: string;
};
export const AnimateGenericFadeInOut = ({
children,
className,
key,
motionKey,
}: AnimateGenericFadeInOutProps) => {
return (
<motion.section
key={key}
key={motionKey}
initial={{
opacity: 0,
}}

View File

@ -141,12 +141,16 @@ export const AddSettingsFormPartial = ({
</TooltipTrigger>
<TooltipContent className="text-foreground max-w-md space-y-2 p-4">
<p>The authentication requirement for recipients to view the document.</p>
<h2>
<strong>Document access</strong>
</h2>
<ul className="space-y-0.5">
<p>The authentication required for recipients to view the document.</p>
<ul className="ml-3.5 list-outside list-disc space-y-0.5 py-2">
<li>
<strong>Require account</strong> - The recipient must have an account,
and be signed in to view the document
<strong>Require account</strong> - The recipient must be signed in to
view the document
</li>
<li>
<strong>None</strong> - The document can be accessed directly by the URL
@ -185,28 +189,33 @@ export const AddSettingsFormPartial = ({
render={({ field }) => (
<FormItem>
<FormLabel className="flex flex-row items-center">
Recipient signing authentication
Recipient action authentication
<Tooltip>
<TooltipTrigger>
<InfoIcon className="mx-2 h-4 w-4" />
</TooltipTrigger>
<TooltipContent className="text-foreground max-w-md space-y-2 p-4">
<p>The authentication requirement for recipients to sign fields.</p>
<h2>
<strong>Global recipient action authentication</strong>
</h2>
<p>
You can also override this global setting by setting the authentication
requirements directly on each recipient in the next step.
The authentication required for recipients to sign fields and complete the
document.
</p>
<ul className="space-y-0.5">
<p>
This can be overriden by setting the authentication requirements directly
on each recipient in the next step.
</p>
<ul className="ml-3.5 list-outside list-disc space-y-0.5 py-2">
<li>
<strong>Require account</strong> - The recipient must have an account,
and be signed in to sign fields
<strong>Require account</strong> - The recipient must be signed in
</li>
<li>
<strong>None</strong> - The recipient does not need any authentication
to sign fields
<strong>None</strong> - No authentication required
</li>
</ul>
</TooltipContent>

View File

@ -174,7 +174,7 @@ export const AddSignersFormPartial = ({
<ShowFieldItem key={index} field={field} recipients={recipients} />
))}
<AnimateGenericFadeInOut key={showAdvancedSettings ? 'Show' : 'Hide'}>
<AnimateGenericFadeInOut motionKey={showAdvancedSettings ? 'Show' : 'Hide'}>
<Form {...form}>
<div className="flex w-full flex-col gap-y-2">
{signers.map((signer, index) => (
@ -259,25 +259,29 @@ export const AddSignersFormPartial = ({
</TooltipTrigger>
<TooltipContent className="text-foreground max-w-md p-4">
<h2>
<strong>Recipient action authentication</strong>
</h2>
<p>
The authentication requirements for recipients to sign fields.
The authentication required for recipients to sign fields and
complete the document.
</p>
<p className="mt-2">This will override any global settings.</p>
<ul className="mt-2 space-y-0.5">
<ul className="ml-3.5 list-outside list-disc space-y-0.5 py-2">
<li>
<strong>Inherit authentication method</strong> - Use the
global recipient signing authentication method configured in
global action signing authentication method configured in
the "General Settings" step
</li>
<li>
<strong>Require account</strong> - The recipient must have
an account, and be signed in to sign fields
<strong>Require account</strong> - The recipient must be
signed in
</li>
<li>
<strong>None</strong> - The recipient does not need any
authentication to sign fields
<strong>None</strong> - No authentication required
</li>
</ul>
</TooltipContent>