diff --git a/.cursorrules b/.cursorrules index 61a306ff0..a40eec787 100644 --- a/.cursorrules +++ b/.cursorrules @@ -1,4 +1,7 @@ +You are an expert in TypeScript, Node.js, Remix, React, Shadcn UI and Tailwind. + Code Style and Structure: + - Write concise, technical TypeScript code with accurate examples - Use functional and declarative programming patterns; avoid classes - Prefer iteration and modularization over code duplication @@ -6,20 +9,25 @@ Code Style and Structure: - Structure files: exported component, subcomponents, helpers, static content, types Naming Conventions: + - Use lowercase with dashes for directories (e.g., components/auth-wizard) - Favor named exports for components TypeScript Usage: -- Use TypeScript for all code; prefer interfaces over types -- Avoid enums; use maps instead + +- Use TypeScript for all code; prefer types over interfaces - Use functional components with TypeScript interfaces Syntax and Formatting: -- Use the "function" keyword for pure functions + +- Create functions using `const fn = () => {}` - Avoid unnecessary curly braces in conditionals; use concise syntax for simple statements - Use declarative JSX +- Never use 'use client' +- Never use 1 line if statements Error Handling and Validation: + - Prioritize error handling: handle errors and edge cases early - Use early returns and guard clauses - Implement proper error logging and user-friendly messages @@ -28,21 +36,40 @@ Error Handling and Validation: - Use error boundaries for unexpected errors UI and Styling: + - Use Shadcn UI, Radix, and Tailwind Aria for components and styling - Implement responsive design with Tailwind CSS; use a mobile-first approach +- When using Lucide icons, prefer the longhand names, for example HomeIcon instead of Home -Performance Optimization: -- Minimize 'use client', 'useEffect', and 'setState'; favor React Server Components (RSC) -- Wrap client components in Suspense with fallback -- Use dynamic loading for non-critical components -- Optimize images: use WebP format, include size data, implement lazy loading +React forms -Key Conventions: -- Use 'nuqs' for URL search parameter state management -- Optimize Web Vitals (LCP, CLS, FID) -- Limit 'use client': - - Favor server components and Next.js SSR - - Use only for Web API access in small components - - Avoid for data fetching or state management +- Use zod for form validation react-hook-form for forms +- Look at TeamCreateDialog.tsx as an example of form usage +- Use
elements, and also wrap the contents of form in a fieldset which should have the :disabled attribute when the form is loading -Follow Next.js docs for Data Fetching, Rendering, and Routing \ No newline at end of file +TRPC Specifics + +- Every route should be in it's own file, example routers/teams/create-team.ts +- Every route should have a types file associated with it, example routers/teams/create-team.types.ts. These files should have the OpenAPI meta, and request/response zod schemas +- The request/response schemas should be named like Z[RouteName]RequestSchema and Z[RouteName]ResponseSchema +- Use create-team.ts and create-team.types.ts as an example when creating new routes. +- When creating the OpenAPI meta, only use GET and POST requests, do not use any other REST methods +- Deconstruct the input argument on it's one line of code. + +Toast usage + +- Use the t`string` macro from @lingui/react/macro to display toast messages + +Remix/ReactRouter Usage + +- Use (params: Route.Params) to get the params from the route +- Use (loaderData: Route.LoaderData) to get the loader data from the route +- When using loaderdata, deconstruct the data you need from the loader data inside the function body +- Do not use json() to return data, directly return the data + +Translations + +- Use string to display translations in jsx code, this should be imported from @lingui/react/macro +- Use the t`string` macro from @lingui/react/macro to display translations in typescript code +- t should be imported as const { t } = useLingui() where useLingui is imported from @lingui/react/macro +- String in constants should be using the t`string` macro diff --git a/.env.example b/.env.example index 15b0b3f5c..7b8872b69 100644 --- a/.env.example +++ b/.env.example @@ -105,6 +105,12 @@ NEXT_PRIVATE_MAILCHANNELS_DKIM_PRIVATE_KEY= # OPTIONAL: Displays the maximum document upload limit to the user in MBs NEXT_PUBLIC_DOCUMENT_SIZE_UPLOAD_LIMIT=5 +# [[EE ONLY]] +# OPTIONAL: The AWS SES API KEY to verify email domains with. +NEXT_PRIVATE_SES_ACCESS_KEY_ID= +NEXT_PRIVATE_SES_SECRET_ACCESS_KEY= +NEXT_PRIVATE_SES_REGION= + # [[STRIPE]] NEXT_PRIVATE_STRIPE_API_KEY= NEXT_PRIVATE_STRIPE_WEBHOOK_SECRET= @@ -127,4 +133,8 @@ E2E_TEST_AUTHENTICATE_USER_EMAIL="testuser@mail.com" E2E_TEST_AUTHENTICATE_USER_PASSWORD="test_Password123" # [[LOGGER]] -NEXT_PRIVATE_LOGGER_HONEY_BADGER_API_KEY= +# OPTIONAL: The file to save the logger output to. Will disable stdout if provided. +NEXT_PRIVATE_LOGGER_FILE_PATH= + +# [[PLAIN SUPPORT]] +NEXT_PRIVATE_PLAIN_API_KEY= diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 70b668b5c..66602d12b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,3 @@ ---- -name: Pull Request -about: Submit changes to the project for review and inclusion ---- - ## Description diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index 5a33362a9..a1eb7453b 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -31,6 +31,9 @@ jobs: - name: Build app run: npm run build + - name: Install playwright browsers + run: npx playwright install --with-deps + - name: Run Playwright tests run: npm run ci env: diff --git a/.github/workflows/translations-upload.yml b/.github/workflows/translations-upload.yml index cb69d6338..adadc0d61 100644 --- a/.github/workflows/translations-upload.yml +++ b/.github/workflows/translations-upload.yml @@ -20,8 +20,6 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 - with: - token: ${{ secrets.GH_PAT }} - uses: ./.github/actions/node-install diff --git a/.gitignore b/.gitignore index b95fcc7d2..f31f951a7 100644 --- a/.gitignore +++ b/.gitignore @@ -50,3 +50,10 @@ yarn-error.log* !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json + +# logs +logs.json + +# claude +.claude +CLAUDE.md \ No newline at end of file diff --git a/.npmrc b/.npmrc index ded82e2f6..99c51b515 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1,3 @@ auto-install-peers = true +legacy-peer-deps = true +prefer-dedupe = true \ No newline at end of file diff --git a/README.md b/README.md index d7f79adda..aa423aa2b 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,6 @@ Join us in creating the next generation of open trust infrastructure. ## Community and Next Steps 🎯 -We're currently working on a redesign of the application, including a revamp of the codebase, so Documenso can be more intuitive to use and robust to develop upon. - - Check out the first source code release in this repository and test it. - Tell us what you think in the [Discussions](https://github.com/documenso/documenso/discussions). - Join the [Discord server](https://documen.so/discord) for any questions and getting to know to other community members. @@ -247,14 +245,14 @@ Now you can install the dependencies and build it: ``` npm i -npm run build:web +npm run build npm run prisma:migrate-deploy ``` Finally, you can start it with: ``` -cd apps/web +cd apps/remix npm run start ``` @@ -275,7 +273,7 @@ After=network.target Environment=PATH=/path/to/your/node/binaries Type=simple User=www-data -WorkingDirectory=/var/www/documenso/apps/web +WorkingDirectory=/var/www/documenso/apps/remix ExecStart=/usr/bin/next start -p 3500 TimeoutSec=15 Restart=always @@ -310,7 +308,7 @@ The Web UI can be found at http://localhost:9000, while the SMTP port will be on ### Support IPv6 -If you are deploying to a cluster that uses only IPv6, You can use a custom command to pass a parameter to the Next.js start command +If you are deploying to a cluster that uses only IPv6, You can use a custom command to pass a parameter to the Remix start command For local docker run diff --git a/apps/documentation/.gitignore b/apps/documentation/.gitignore index fd3dbb571..35bcb7373 100644 --- a/apps/documentation/.gitignore +++ b/apps/documentation/.gitignore @@ -34,3 +34,8 @@ yarn-error.log* # typescript *.tsbuildinfo next-env.d.ts + +# next-sitemap output +/public/sitemap.xml +/public/robots.txt +/public/sitemap-*.xml diff --git a/apps/documentation/next-sitemap.config.js b/apps/documentation/next-sitemap.config.js new file mode 100644 index 000000000..53571e850 --- /dev/null +++ b/apps/documentation/next-sitemap.config.js @@ -0,0 +1,5 @@ +/** @type {import('next-sitemap').IConfig} */ +module.exports = { + siteUrl: 'https://docs.documenso.com', // Replace with your actual site URL + generateRobotsTxt: true, // Generates robots.txt +}; diff --git a/apps/documentation/next.config.js b/apps/documentation/next.config.js index 290cb03e8..cf8ff8811 100644 --- a/apps/documentation/next.config.js +++ b/apps/documentation/next.config.js @@ -1,3 +1,5 @@ +import nextra from 'nextra'; + /** @type {import('next').NextConfig} */ const nextConfig = { transpilePackages: [ @@ -9,9 +11,10 @@ const nextConfig = { ], }; -const withNextra = require('nextra')({ +const withNextra = nextra({ theme: 'nextra-theme-docs', themeConfig: './theme.config.tsx', + codeHighlight: true, }); -module.exports = withNextra(nextConfig); +export default withNextra(nextConfig); diff --git a/apps/documentation/package.json b/apps/documentation/package.json index 76def45e1..6408e156b 100644 --- a/apps/documentation/package.json +++ b/apps/documentation/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "dev": "next dev -p 3002", - "build": "next build", + "build": "next build && next-sitemap", "start": "next start -p 3002", "lint:fix": "next lint --fix", "clean": "rimraf .next && rimraf node_modules" @@ -15,7 +15,7 @@ "@documenso/tailwind-config": "*", "@documenso/trpc": "*", "@documenso/ui": "*", - "next": "14.2.6", + "next": "14.2.28", "next-plausible": "^3.12.0", "nextra": "^2.13.4", "nextra-theme-docs": "^2.13.4", @@ -26,6 +26,7 @@ "@types/node": "^20", "@types/react": "^18", "@types/react-dom": "^18", + "next-sitemap": "^4.2.3", "typescript": "5.6.2" } -} \ No newline at end of file +} diff --git a/apps/documentation/pages/developers/_meta.json b/apps/documentation/pages/developers/_meta.json index 0057496b3..b3238257d 100644 --- a/apps/documentation/pages/developers/_meta.json +++ b/apps/documentation/pages/developers/_meta.json @@ -5,6 +5,7 @@ "title": "Development & Deployment" }, "local-development": "Local Development", + "developer-mode": "Developer Mode", "self-hosting": "Self Hosting", "contributing": "Contributing", "-- API & Integration Guides": { diff --git a/apps/documentation/pages/developers/developer-mode/field-coordinates.mdx b/apps/documentation/pages/developers/developer-mode/field-coordinates.mdx new file mode 100644 index 000000000..7489912e6 --- /dev/null +++ b/apps/documentation/pages/developers/developer-mode/field-coordinates.mdx @@ -0,0 +1,18 @@ +--- +title: Field Coordinates +description: Learn how to get the coordinates of a field in a document. +--- + +## Field Coordinates + +Field coordinates represent the position of a field in a document. They are returned in the `pageX` and `pageY` properties of the field. + +To enable field coordinates, you can use the `devmode` query parameter. + +```bash +https://app.documenso.com/documents//edit?devmode=true +``` + +You should then see the coordinates on top of each field. + +![Field Coordinates](/developer-mode/field-coordinates.webp) diff --git a/apps/documentation/pages/developers/public-api/_meta.json b/apps/documentation/pages/developers/public-api/_meta.json index 025d862a5..04132f894 100644 --- a/apps/documentation/pages/developers/public-api/_meta.json +++ b/apps/documentation/pages/developers/public-api/_meta.json @@ -1,5 +1,6 @@ { "index": "Get Started", "authentication": "Authentication", + "rate-limits": "Rate Limits", "versioning": "Versioning" } diff --git a/apps/documentation/pages/developers/public-api/index.mdx b/apps/documentation/pages/developers/public-api/index.mdx index 050810863..81b7536aa 100644 --- a/apps/documentation/pages/developers/public-api/index.mdx +++ b/apps/documentation/pages/developers/public-api/index.mdx @@ -33,7 +33,7 @@ Our new API V2 supports the following typed SDKs: For the staging API, please use the following base URL: - `https://stg-app.documenso.dev/api/v2-beta/` + `https://stg-app.documenso.com/api/v2-beta/` 🚀 [V2 Announcement](https://documen.so/sdk-blog) diff --git a/apps/documentation/pages/developers/public-api/rate-limits.mdx b/apps/documentation/pages/developers/public-api/rate-limits.mdx new file mode 100644 index 000000000..1941258cd --- /dev/null +++ b/apps/documentation/pages/developers/public-api/rate-limits.mdx @@ -0,0 +1,54 @@ +import { Callout } from 'nextra/components'; + +# Rate Limits + +Documenso enforces rate limits on all API endpoints to ensure service stability. + +## HTTP Rate Limits + +**Limit:** 100 requests per minute per IP address +**Response:** 429 Too Many Requests + +### Rate Limit Response + +```json +{ + "error": "Too many requests, please try again later." +} +``` + + + No rate limit headers are currently provided. When you receive a 429 response, wait at least 60 + seconds before retrying. + + +## Resource Limits + +Beyond HTTP rate limits, your account has usage limits based on your subscription plan. + +### Plan Limits + +| Resource | Free | Paid | Self-hosted | Enterprise | +| ---------------- | ---- | --------- | ----------- | ---------- | +| Documents/month | 5 | Unlimited | Unlimited | Unlimited | +| Total Recipients | 10 | Unlimited | Unlimited | Unlimited | +| Direct Templates | 3 | Unlimited | Unlimited | Unlimited | + +### Error Response + +When you exceed a resource limit: + +```json +{ + "error": "You have reached your document limit for this month. Please upgrade your plan.", + "code": "LIMIT_EXCEEDED", + "statusCode": 400 +} +``` + +## Error Codes + +| Code | Status | Description | +| ------------------- | ------ | ----------------------------- | +| `TOO_MANY_REQUESTS` | 429 | HTTP rate limit exceeded | +| `LIMIT_EXCEEDED` | 400 | Resource usage limit exceeded | diff --git a/apps/documentation/pages/developers/webhooks.mdx b/apps/documentation/pages/developers/webhooks.mdx index 1155e32c8..8fac71210 100644 --- a/apps/documentation/pages/developers/webhooks.mdx +++ b/apps/documentation/pages/developers/webhooks.mdx @@ -619,6 +619,18 @@ Example payload for the `document.rejected` event: } ``` +## Webhook Events Testing + +You can trigger test webhook events to test the webhook functionality. To trigger a test webhook, navigate to the [Webhooks page](/developers/webhooks) and click on the "Test Webhook" button. + +![Documenso's Webhooks Page](/webhook-images/test-webhooks-page.webp) + +This opens a dialog where you can select the event type to test. + +![Documenso's individual webhook page](/webhook-images/test-webhook-dialog.webp) + +Choose the appropriate event and click "Send Test Webhook." You’ll shortly receive a test payload from Documenso with sample data. + ## Availability Webhooks are available to individual users and teams. diff --git a/apps/documentation/pages/users/_meta.json b/apps/documentation/pages/users/_meta.json index 335b80eb4..3726fbd08 100644 --- a/apps/documentation/pages/users/_meta.json +++ b/apps/documentation/pages/users/_meta.json @@ -6,11 +6,13 @@ "title": "How To Use" }, "get-started": "Get Started", - "profile": "User Profile", - "signing-documents": "Signing Documents", + "profile": "Public Profile", + "organisations": "Organisations", + "documents": "Documents", "templates": "Templates", + "branding": "Branding", + "email-domains": "Email Domains", "direct-links": "Direct Signing Links", - "teams": "Teams", "-- Legal Overview": { "type": "separator", "title": "Legal Overview" @@ -18,4 +20,4 @@ "fair-use": "Fair Use Policy", "licenses": "Licenses", "compliance": "Compliance" -} +} \ No newline at end of file diff --git a/apps/documentation/pages/users/branding.mdx b/apps/documentation/pages/users/branding.mdx new file mode 100644 index 000000000..68fb16cf5 --- /dev/null +++ b/apps/documentation/pages/users/branding.mdx @@ -0,0 +1,28 @@ +--- +title: Branding Preferences +description: Learn how to set the branding preferences for your team account. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Branding Preferences + +Branding preferences allow you to set the default settings when emailing documents to your recipients. + +## Preferences + +Branding preferences can be set on either the organisation or team level. + +By default, teams inherit the preferences from the organisation. You can override these preferences on the team level at any time. + +To access the preferences, navigate to either the organisation or teams settings page and click the **Branding** tab under the **Preferences** section. + +![A screenshot of the organisation's document preferences page](/organisations/organisation-branding.webp) + +On this page, you can: + +- **Upload a Logo** - Upload your team's logo to be displayed instead of the default Documenso logo. +- **Set the Brand Website** - Enter the URL of your team's website to be displayed in the email communications sent by the team. +- **Add Additional Brand Details** - You can add additional information to display at the bottom of the emails sent by the team. This can include contact information, social media links, and other relevant details. diff --git a/apps/documentation/pages/users/documents/_meta.json b/apps/documentation/pages/users/documents/_meta.json new file mode 100644 index 000000000..9312fe12c --- /dev/null +++ b/apps/documentation/pages/users/documents/_meta.json @@ -0,0 +1,7 @@ +{ + "sending-documents": "Sending Documents", + "document-preferences": "Document Preferences", + "document-visibility": "Document Visibility", + "fields": "Document Fields", + "email-preferences": "Email Preferences" +} \ No newline at end of file diff --git a/apps/documentation/pages/users/documents/document-preferences.mdx b/apps/documentation/pages/users/documents/document-preferences.mdx new file mode 100644 index 000000000..0b1e3093b --- /dev/null +++ b/apps/documentation/pages/users/documents/document-preferences.mdx @@ -0,0 +1,44 @@ +--- +title: Preferences +description: Learn how to manage your team's global preferences. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Document Preferences + +Document preferences allow you to set the default settings when creating new documents and templates. + +For example, you can set the default language for documents sent by the team, or set the allowed signatures types. + +## Preferences + +Document preferences can be set on either the organisation or team level. + +By default, teams inherit the preferences from the organisation. You can override these preferences on the team level at any time. + +To access the preferences, navigate to either the organisation or teams settings page and click the **Document** tab under the **Preferences** section. + +![A screenshot of the organisation's document preferences page](/organisations/organisation-document-preferences.webp) + +- **Document Visibility** - Set the default visibility of the documents created by team members. Learn more about [document visibility](/users/documents/document-visibility). +- **Default Document Language** - This setting allows you to set the default language for the documents uploaded in the organisation. The default language is used as the default language in the email communications with the document recipients. +- **Default Time Zone** - The timezone to use for date fields and signing the document. +- **Default Date Format** - The date format to use for date fields and signing the document. +- **Signature Settings** - Controls what signatures are allowed to be used when signing the documents. +- **Sender Details** - Set whether the sender's name should be included in the emails sent by the team. See more below [sender details](/users/documents/document-preferences#sender-details). +- **Include the Signing Certificate** - This setting controls whether the signing certificate should be included in the signed documents. If enabled, the signing certificate is included in the signed documents. If disabled, the signing certificate is not included in the signed documents. Regardless of this setting, the signing certificate is always available in the document's audit log page. + +Document visibility, language and signature settings can be overriden on a per document basis. + +### Sender Details + +If the **Sender Details** setting is enabled, the emails sent by the team will include the sender's name. The email will say: + +> "Example User" on behalf of "Example Team" has invited you to sign "document.pdf" + +If the **Sender Details** setting is disabled, the emails sent by the team will not include the sender's name. The email will say: + +> "Example Team" has invited you to sign "document.pdf" diff --git a/apps/documentation/pages/users/teams/document-visibility.mdx b/apps/documentation/pages/users/documents/document-visibility.mdx similarity index 83% rename from apps/documentation/pages/users/teams/document-visibility.mdx rename to apps/documentation/pages/users/documents/document-visibility.mdx index 818c51b47..92530feb3 100644 --- a/apps/documentation/pages/users/teams/document-visibility.mdx +++ b/apps/documentation/pages/users/documents/document-visibility.mdx @@ -5,19 +5,25 @@ description: Learn how to control the visibility of your team documents. import { Callout } from 'nextra/components'; -# Team's Document Visibility +# Document Visibility -The default document visibility option allows you to control who can view and access the documents uploaded to your team account. The document visibility can be set to one of the following options: +The default document visibility option allows you to control who can view and access the documents uploaded within a team. + +This value can either be set in the [document preferences](/users/documents/document-preferences), or when you [create the document](/users/documents/send-document) + +## Document Visibility Options + +The document visibility can be set to one of the following options: - **Everyone** - The document is visible to all team members. - **Managers and above** - The document is visible to team members with the role of _Manager or above_ and _Admin_. - **Admin only** - The document is only visible to the team's admins. -![A screenshot of the document visibility selector from the team's global preferences page](/teams/team-preferences-document-visibility.webp) +The default document visibility is set to "_EVERYONE_" by default. You can change this setting by going to the [document preferences page](/users/documents/document-preferences) and selecting a different visibility option. -The default document visibility is set to "_EVERYONE_" by default. You can change this setting by going to the [team's general preferences page](/users/teams/preferences) and selecting a different visibility option. +![Document visibility preference](/organisations/organisation-document-visibility.webp) -Here's how it works: +## How it works - If a user with the "_Member_" role creates a document and the default document visibility is set to "_Everyone_", the document's visibility is set to "_EVERYONE_". - The user can't change the visibility of the document in the document editor. diff --git a/apps/documentation/pages/users/documents/email-preferences.mdx b/apps/documentation/pages/users/documents/email-preferences.mdx new file mode 100644 index 000000000..95cc42456 --- /dev/null +++ b/apps/documentation/pages/users/documents/email-preferences.mdx @@ -0,0 +1,26 @@ +--- +title: Email Preferences +description: Learn how to set the email preferences for your team account. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Email Preferences + +Email preferences allow you to set the default settings when emailing documents to your recipients. + +## Preferences + +Email preferences can be set on either the organisation or team level. + +By default, teams inherit the preferences from the organisation. You can override these preferences on the team level at any time. + +To access the preferences, navigate to either the organisation or teams settings page and click the **Email** tab under the **Preferences** section. + +![A screenshot of the organisation's email preferences page](/organisations/organisation-email-preferences.webp) + +- **Default Email** - Use a custom email address when sending documents to your recipients. See [email domains](/users/email-domains) for more information. +- **Reply To** - The email address that will be used in the "Reply To" field in emails +- **Email Settings** - Which emails to send to recipients during document signing diff --git a/apps/documentation/pages/users/signing-documents/fields.mdx b/apps/documentation/pages/users/documents/fields.mdx similarity index 100% rename from apps/documentation/pages/users/signing-documents/fields.mdx rename to apps/documentation/pages/users/documents/fields.mdx diff --git a/apps/documentation/pages/users/signing-documents/index.mdx b/apps/documentation/pages/users/documents/sending-documents.mdx similarity index 99% rename from apps/documentation/pages/users/signing-documents/index.mdx rename to apps/documentation/pages/users/documents/sending-documents.mdx index f37afc8f7..19d012bc3 100644 --- a/apps/documentation/pages/users/signing-documents/index.mdx +++ b/apps/documentation/pages/users/documents/sending-documents.mdx @@ -115,7 +115,7 @@ All fields can be placed anywhere on the document and resized as needed. Learn more about the available field types and how to use them on the [Fields - page](signing-documents/fields). + page](/users/documents/fields). #### Signature Required diff --git a/apps/documentation/pages/users/email-domains.mdx b/apps/documentation/pages/users/email-domains.mdx new file mode 100644 index 000000000..d28b467e3 --- /dev/null +++ b/apps/documentation/pages/users/email-domains.mdx @@ -0,0 +1,111 @@ +import { Callout, Steps } from 'nextra/components'; + +# Email Domains + +Email Domains allow you to send emails to recipients from your own domain instead of the default Documenso email address. + + + **Enterprise Only**: Email Domains is only available to Enterprise customers and custom plans + + +## Creating Email Domains + +Before setting up email domains, ensure you have: + +- An Enterprise subscription +- Access to your domain's DNS settings +- Access to your Documenso organisation as an admin or manager + + + +### Access Email Domains Settings + +Navigate to your Organisation email domains settings page and click the "Add Email Domain" button. + +![Email Domains settings page](/email-domains/email-domains-settings-page.webp) + +### Configure DNS Records + +After adding your domain, Documenso will provide you with the following required DNS records that need to be configured on your domain: + +- **SPF Record**: Specifies which servers are authorized to send emails from your domain +- **DKIM Record**: Provides email authentication and prevents tampering + +![DNS configuration instructions](/email-domains/email-domains-record.webp) + + + If you already have an SPF record configured, you will need to update it to include Amazon SES as + an authorized server instead of creating a new record. + + +Configure these records in your domain's DNS settings according to their specific instructions. + +### Verify Domain Configuration + +Once you've added the DNS records, return to the Documenso email domains settings page and click the "Verify" button. +This will trigger a verification process which will check if the DNS records are properly configured. If successful, the domain will be marked as "Active". + +![Domain verification process](/email-domains/email-domain-sync.webp) + + + Please note that it may take up to 48 hours for the DNS records to propagate. + + + + +## Creating Emails + +Once your email domain has been configured, you can create multiple email addresses which your members can use when sending documents to recipients. + + + +### Select the Email Domain You Want to Use + +Navigate to the email domains settings page and click "Manage" on the domain you want to use. + +![Email Domains settings page](/email-domains/email-domains-manage.webp) + +### Add a New Email + +Click on the "Add Email" button to begin the setup process. + +![Create email](/email-domains/email-domains-manage-create-email.webp) + +### Use Email + +Once you have added an email, you can configure it to be the default email on either the: + +- Organisation email preferences page +- Team email preferences page + +When a draft document is created, it will inherit the email configured on the team if set, otherwise it will inherit the email configured in the organisation. + +You can also configure the email address directly on the document to override the default email if required. + + + +## Notes + +- If you change the default email, it will not retroactively update any existing documents with the old default email. +- If the email domain becomes invalid, all emails using that domain will fail to send. + +## Troubleshooting + +### Common Issues + +**DNS Verification Fails** + +- Double-check all DNS record values +- Ensure records are added to the correct domain +- Wait for DNS propagation (up to 48 hours) + +**Emails Not Delivering** + +- Check domain reputation and blacklist status +- Verify SPF, DKIM, and DMARC records +- Review bounce and spam reports + + + For additional support with Email Domains configuration, contact our support team at + support@documenso.com. + diff --git a/apps/documentation/pages/users/get-started/account-creation.mdx b/apps/documentation/pages/users/get-started/account-creation.mdx index bf1f67983..bea55e060 100644 --- a/apps/documentation/pages/users/get-started/account-creation.mdx +++ b/apps/documentation/pages/users/get-started/account-creation.mdx @@ -10,7 +10,7 @@ import { Callout, Steps } from 'nextra/components'; ### Pick a Plan -The first step to start using Documenso is to pick a plan and create an account. At the moment of writing this guide, we have 3 plans available: Free, Individual, and Teams. +The first step to start using Documenso is to pick a plan and create an account. At the moment of writing this guide, we have 3 plans available: Free, Individual, Teams and Platform. Explore each plan's features and choose the one that best suits your needs. The [pricing page](https://documen.so/pricing) has more information about the plans. @@ -28,6 +28,6 @@ You can claim a premium username by upgrading to a paid plan. After upgrading to ### Optional: Create a Team -If you are working with others, you can create a team and invite your team members to collaborate on your documents. More information about teams is available in the [Teams section](/users/get-started/teams). +If you are working with others, you can create a team and invite your team members to collaborate on your documents. More information about teams is available in the [Teams section](/users/organisations/teams). diff --git a/apps/documentation/pages/users/get-started/teams.mdx b/apps/documentation/pages/users/get-started/teams.mdx deleted file mode 100644 index bfb4e6b8c..000000000 --- a/apps/documentation/pages/users/get-started/teams.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: Teams -description: Learn how to create and manage teams in Documenso. ---- - -import Image from 'next/image'; - -import { Callout, Steps } from 'nextra/components'; - -# Teams - -Documenso allows you to create teams to collaborate with others on creating and signing documents. - - - -### Create a New Team - -Anyone can create a team from their account by clicking on the "+" (plus) button in the "Teams" section from the account dropdown. - -![Documenso account dropdown menu](/get-started-images/add-team.webp) - -Each team is a separate entity with its members, documents, and templates. You can create as many teams as you like but remember that each team is billed separately. - -You can transfer the ownership of the team at any time. - -### Name and URL - -Clicking the "+" button will open a modal where you must pick your team's name and URL. The URL is the team's identifier and will link to the team's page and settings. An example URL would be: - -```bash -https://app.documenso.com/t/ -``` - -![Documenso create team modal](/get-started-images/add-team-2.webp) - -You can select a different name and URL for your team, but we recommend using the same or similar name. - -### Invite Team Members - -After creating the team, you can invite team members by navigating to the "Members" tab in the team settings and clicking the "Invite member" button. - -To access the team settings, click on the team's name in the account dropdown and select the appropriate team. Lastly, click again on the avatar and then "Team Settings". - -Or you can copy this URL: - -```bash -https://app.documenso.com/t//settings/members -``` - -Once you click on the "Invite member" button, you will be prompted to enter the email address of the person you want to invite. You can also select the role of the person you are inviting. - -![Invite team members in Documenso dashboard](/get-started-images/add-team-members-documenso.webp) - -You can also bulk-invite members by uploading a CSV file with the email addresses and roles of the people you want to invite. - -The table below shows how the CSV file should be structured: - -| Email address | Role | -| -------------------------- | ------- | -| team-admin@documenso.com | Admin | -| team-manager@documenso.com | Manager | -| team-member@documenso.com | Member | - - - The basic team plan includes 5 members. You can invite as many members as you like by upgrading - your team's seats on the team's billing page. - - -#### Roles - -You can assign different permissions to team members based on their roles. The roles available are: - -| Role | Create, Edit, Send Documents | Manage Users | Manage Admins | Settings | Billing | Delete/ Transfer | -| :-----: | :--------------------------: | :----------: | :-----------: | :------: | :-----: | :--------------: | -| Member | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | -| Manager | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ | -| Admin | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| Owner | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - -### Set a Team Email - -You can add a team email to make signing and sending documents easier. Adding a team email allows you to: - -- See a signing request sent to this email (Team Inbox) -- See all documents sent on behalf of the team - -### (Optional) Transfer Team Ownership - -You can transfer the team's ownership at any time. To do this, navigate to the "General" tab in the team settings and click the "Transfer team" button. - -Use this URL to get to the team settings: - -```bash -https://app.documenso.com/t//settings -``` - -### [Send your First Document](https://app.documenso.com/) - - diff --git a/apps/documentation/pages/users/organisations/_meta.json b/apps/documentation/pages/users/organisations/_meta.json new file mode 100644 index 000000000..b77f9137c --- /dev/null +++ b/apps/documentation/pages/users/organisations/_meta.json @@ -0,0 +1,7 @@ +{ + "index": "Introduction", + "members": "Members", + "groups": "Groups", + "teams": "Teams", + "billing": "Billing" +} \ No newline at end of file diff --git a/apps/documentation/pages/users/organisations/billing.mdx b/apps/documentation/pages/users/organisations/billing.mdx new file mode 100644 index 000000000..571e9408c --- /dev/null +++ b/apps/documentation/pages/users/organisations/billing.mdx @@ -0,0 +1,19 @@ +--- +title: Billing +description: Learn how to manage your organisation's billing and subscription. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +### Billing and Subscription Management + +Organisations handle billing centrally, making it easier to manage: + +- **Unified Billing**: One subscription covers all teams in the organisation +- **Seat Management**: Add or remove seats across all teams automatically (Teams plan) + +You can change plans, view invoices and manage your subscription from the billing page which is accessible from the organisation settings. + +![A screenshot of the organisation's billing page](/organisations/organisations-billing.webp) diff --git a/apps/documentation/pages/users/organisations/groups.mdx b/apps/documentation/pages/users/organisations/groups.mdx new file mode 100644 index 000000000..6c2148d55 --- /dev/null +++ b/apps/documentation/pages/users/organisations/groups.mdx @@ -0,0 +1,75 @@ +--- +title: Preferences +description: Learn how to manage your team's global preferences. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Organisation Groups + +Organisation groups are a powerful administrative tool that streamlines user management across your entire organisation. Instead of manually assigning individual users to multiple teams, groups allow you to manage access at scale. + +This automated approach ensures consistent permissions while reducing administrative overhead for tasks like onboarding employees or managing contractor access. + +## Understanding groups + +### Key Benefits + +- **Instant Access Management**: New hires get immediate, appropriate access across all relevant teams +- **Bulk Operations**: Remove an entire group (like a departing contractor team) and all members lose access simultaneously +- **Role Consistency**: Ensure the same role is applied consistently across teams—no more accidentally giving admin access when member access was intended +- **Audit Trail**: Easily track which groups have access to which teams + +### Example use case: Legal Compliance Team + +Imagine you have a legal compliance team that needs access to review documents across all departments. Instead of manually adding each legal team member to every departmental team (Sales, Marketing, HR, Operations), you can: + +1. Create a "Legal Compliance" group with the "Member" Organisation Role +2. Add legal team members to this group +3. Assign the "Legal Compliance" group to the required teams + +Now, when Sarah from Legal joins the company, you can simply add her to the "Legal Compliance" group. Once added, she automatically gains access to all teams the "Legal Compliance" group is assigned to. + +When John from Legal leaves the company, you remove him from the group and his access is instantly revoked across all teams. + +## Getting started with groups + +Navigate to the "Groups" section in your organisation settings to create and manage groups. + +There are two types of roles when using groups: + +- **Organisation Role**: A global organisation role given to all members of the group +- **Team Role**: A team role you select when assigning the group to a team + +You should generally have the "Organisation Role" set to "Organisation Member", otherwise these members would by default have access to all teams anyway due to the high organisation role. + +### Creating Custom Groups + +When creating a custom group, you can: + +1. **Name the Group**: Give it a descriptive name that reflects its purpose +2. **Set Organisation Role**: Define the default **organisation role** for group members +3. **Add Members**: Include organisation members in the group + +![Organisation group creation](/organisations/organisation-group-create.webp) + +### Manage Custom Groups + +By clicking the "Manage" button on a custom group, you can view all teams it is assigned to and modify the group's settings. + +![Organisation group management](/organisations/organisation-group-manage.webp) + +### Assigning a group to a team + +To assign a group to a team, you need to navigate to the team settings and click the "Groups" tab. + +![Organisation group assignment](/organisations/organisation-group-assignment.webp) + +From here, click the "Add groups" button to begin the process of assigning a group to a team. Once you have added the group you can see that the members have been automatically added to the team in the members tab. + +## What's next? + +- [Create Your First Team](/users/organisations/teams) +- [Manage Default Settings](/users/documents/document-preferences) diff --git a/apps/documentation/pages/users/organisations/index.mdx b/apps/documentation/pages/users/organisations/index.mdx new file mode 100644 index 000000000..0c094e44b --- /dev/null +++ b/apps/documentation/pages/users/organisations/index.mdx @@ -0,0 +1,65 @@ +--- +title: Organisations +description: Learn how to create and manage organisations in Documenso. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Organisations + +Organisations allow you to manage multiple teams and users under a single managed entity. This powerful feature enables enterprise-level collaboration and streamlined management across your entire organisation. + +## What are Organisations? + +Organisations are the top-level entity in Documenso's hierarchy structure: + +![Organisations diagram](/organisations/organisations-basic-diagram.webp) + +Each organisation can contain multiple teams, and each team can have multiple members. This structure provides: + +- **Centralized Management**: Control multiple teams from a single organisational dashboard +- **Unified Billing**: Manage billing and subscriptions at the organisation level +- **Access Control**: Define roles and groups across the entire organisation +- **Group Management**: Create custom groups to organise members and control team access +- **Global Settings**: Apply consistent settings across all teams in your organisation + +## Create a new organisation + +You can create multiple organisations, but each organisation will be billed separately. + + + +### Creating Organisations + +To create a new organisation, navigate to the organisation section in your account settings and click the "Create Organisation" button. + +![Create organisation in Documenso dashboard](/organisations/organisations-create.webp) + +### Select your plan + +Choose from our range of plans for your new organisation. If you want to instead upgrade your current organisation, you can do so by going into your settings billing page and upgrade it there. + +### Name setup + +When creating an organisation, you'll need to provide: + +- **Organisation Name**: The display name for your organisation + + + +Once your organisation is established, you can create teams to organise your work and collaborate effectively. Each team operates independently but inherits organisation-level settings and branding. + +## Best Practices for Organisation Management + +1. **Use groups effectively**: Leverage groups to simplify permission management +2. **Set default settings**: Configure organisation-wide settings for consistency + +## What's next? + +- [Create Your First Team](/users/organisations/teams) +- [Invite Organisation Members](/users/organisations/members) +- [Create Organisation Groups](/users/organisations/groups) +- [Manage Default Settings](/users/documents/document-preferences) +- [Manage Default Branding](/users/branding) diff --git a/apps/documentation/pages/users/organisations/members.mdx b/apps/documentation/pages/users/organisations/members.mdx new file mode 100644 index 000000000..e66212b84 --- /dev/null +++ b/apps/documentation/pages/users/organisations/members.mdx @@ -0,0 +1,65 @@ +--- +title: Members +description: Learn how to invite and manage your organisation's members. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Organisation Members + +Organisation members are the core users of your organisation. They are the ones who can access the team resources and collaborate with other members. + +## Organisation Roles + +You can assign different permissions to organisation members by using roles. The roles available are: + +| Role | Manage Settings/Teams/Members | Billing | Delete Organisation | +| :------------------: | :---------------------------: | :-----: | ------------------- | +| Organisation Owner | ✅ | ✅ | ✅ | +| Organisation Admin | ✅ | ✅ | ✅ | +| Organisation Manager | ✅ | ❌ | ❌ | +| Organisation Member | ❌ | ❌ | ❌ | + + + Organisation admins and managers will automatically have access to all teams as the "Team Admin" + role. When creating a team you can also decide whether to automatically allow normal members to + access it by default as well. + + +## Invite Organisation Members + +To invite organisation members, you need to be an organisation owner, admin or manager. + +1. Open the menu switcher top right +2. Hover over your new organisation and click the settings icon +3. Navigate to the "Members" tab +4. Click "Invite Member" + +Once you click on the "Invite member" button, you will be prompted to enter the email address of the person you want to invite. You can also select the role of the person you are inviting. + +![Invite organisation members](/organisations/organisations-member-invite.webp) + +You can also bulk-invite members by uploading a CSV file with the email addresses and roles of the people you want to invite. + +The table below shows how the CSV file should be structured: + +| Email address | Role | +| ------------------------- | ------- | +| org-admin@documenso.com | Admin | +| org-manager@documenso.com | Manager | +| org-member@documenso.com | Member | + + + The basic team plan includes 5 organisation members. Going over the 5 members will charge your + organisation according to the seat plan pricing. + + +## Manage Organisation Members + +On the same page, you can change the organisation member's roles or remove them from the organisation. + +## What's next? + +- [Use groups to organise your members](/users/organisations/groups) diff --git a/apps/documentation/pages/users/organisations/teams.mdx b/apps/documentation/pages/users/organisations/teams.mdx new file mode 100644 index 000000000..9b9e63675 --- /dev/null +++ b/apps/documentation/pages/users/organisations/teams.mdx @@ -0,0 +1,121 @@ +--- +title: Teams +description: Learn how to create and manage teams in Documenso. +--- + +import Image from 'next/image'; + +import { Callout, Steps } from 'nextra/components'; + +# Teams + +Documenso teams allow you to collaborate with others on creating, sending and receiving documents within your organisation. Teams operate within the organisational structure and inherit settings and branding from their parent organisation. + +## Team Structure + +Teams provide focused collaboration spaces while benefiting from organisation-level management and settings. + +Each team within an organisation has its own: + +- Team members and roles +- Documents and templates +- Team-specific settings (that can override organisation defaults) +- Team email and branding (if enabled) + +## Creating a Team + +Only members with the "Organisation Admin" or "Organisation Manager" role can create teams. + + + +### Create Team + +To create a team, navigate to the organisation settings page and click the "Teams" tab. Then you can click the "Create Team" button. + +![Create Team Dialog](/teams/team-create.webp) + +### Name and URL + +When creating a team, you'll need to provide: + +- **Team Name**: The display name for your team +- **Team URL**: A unique identifier for your team + +The team URL will follow this format: + +```bash +https://app.documenso.com/t/ +``` + +You can select different names and URLs for your team, but we recommend using the same or similar names for consistency. + +![Documenso create team modal](/teams/team-create-dialog.webp) + +You can also decide whether to automatically inherit members from the organisation into the team. This means that all members of the organisation will have access to this team. + +Members with the "Organisation Admin" or "Organisation Manager" role will be assigned as "Team Admin" regardless of this setting. This will only affect members with the "Organisation Member" role, who will be added to the team as a "Team Member". + +Disabling this setting will remove all these members automatically. This can always be turned on or off later in the teams member settings page. + + + +## Team Members + +After creating the team, you can add organisation members into your team using two methods: + +- Directly adding members to the team +- Add members using groups + +### Directly adding members + +1. Navigate to the team settings member page +2. Click the "Add Members" button +3. Choose which members you want to add +4. Assign the team roles for each team member + +If you want to add people outside of the organisation, you will need to invite them to the organisation first. + +See the [organisation members](/users/organisations/members#invite-organisation-members) page for more information. + +### Adding members using groups + +1. Navigate to the teams settings groups page +2. Click the "Add groups" button +3. Choose which groups you want to add +4. Assign the team roles for each group + +See the [organisation groups](/users/organisations/groups) page for more information. + +### Team Member Roles + +You can assign different permissions to team members based on their roles. The roles available are: + +| Role | Manage Documents | Manage Team | Delete Team | +| :----------: | :--------------: | :---------: | :---------: | +| Team Admin | ✅ | ✅ | ✅ | +| Team Manager | ✅ | ✅ | ❌ | +| Team Member | ✅ | ❌ | ❌ | + +These roles can be used for document visibility and management as well. + +## Set a Team Email + +You can add a team email which allows you to: + +- See signing requests sent to this email (Team Inbox) +- See documents sent from this email +- Send documents on behalf of the team +- Maintain consistent team branding in communications + +## Team Settings and Branding + +You can override preferences and settings from the Organisation on the Team level. See the following pages for more information: + +- [Document preferences](/users/documents/document-preferences) +- [Branding preferences](/users/branding/branding-preferences) + +## What's next? + +- [Send your first document](/users/documents/sending-documents) +- [Setup your default document preferences](/users/documents/document-preferences) +- [Setup your default branding preferences](/users/branding) diff --git a/apps/documentation/pages/users/profile.mdx b/apps/documentation/pages/users/profile.mdx index 4b7e5b1ff..780c226c8 100644 --- a/apps/documentation/pages/users/profile.mdx +++ b/apps/documentation/pages/users/profile.mdx @@ -1,5 +1,5 @@ --- -title: User Profile +title: Public Profile description: Learn how to set up your public profile on Documenso. --- @@ -15,7 +15,7 @@ Documenso allows you to create a public profile to share your templates for anyo ### Navigate to Your Profile Settings -Click on your profile picture in the top right corner and select "User settings". Then, navigate to the "Public Profile" tab to configure your profile. +Click on your profile picture in the top right corner and select "Settings" or "Team Settings". Then, navigate to the "Public Profile" tab to configure your profile. ![The profile settings page](/public-profile/documenso-public-profile-settings.webp) @@ -45,6 +45,8 @@ You can choose to make your profile public or private. Only you can access it if To make your profile public, toggle the switch to the right ("Show") at the top right-hand side of the page. +![An example of a enabling a public profile on Documenso](/public-profile/documenso-enable-public-profile-settings.webp) + ### (Optional) Link Templates Linking templates to your profile is optional, but it's what makes your profile helpful. Linking templates allow people to sign documents directly from your profile. As a result, we recommend linking at least one template you want to share with others. diff --git a/apps/documentation/pages/users/signing-documents/_meta.json b/apps/documentation/pages/users/signing-documents/_meta.json deleted file mode 100644 index 6fdc8b23e..000000000 --- a/apps/documentation/pages/users/signing-documents/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "index": "Send Documents", - "fields": "Document Fields" -} diff --git a/apps/documentation/pages/users/teams/_meta.json b/apps/documentation/pages/users/teams/_meta.json deleted file mode 100644 index fc849e49d..000000000 --- a/apps/documentation/pages/users/teams/_meta.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "preferences": "Preferences", - "document-visibility": "Document Visibility", - "sender-details": "Email Sender Details", - "branding-preferences": "Branding Preferences" -} diff --git a/apps/documentation/pages/users/teams/branding-preferences.mdx b/apps/documentation/pages/users/teams/branding-preferences.mdx deleted file mode 100644 index 15e074af7..000000000 --- a/apps/documentation/pages/users/teams/branding-preferences.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Branding Preferences -description: Learn how to set the branding preferences for your team account. ---- - -# Branding Preferences - -You can set the branding preferences for your team account by going to the **Branding Preferences** tab in the team's settings dashboard. - -![A screenshot of the team's branding preferences page](/teams/team-branding-preferences.webp) - -On this page, you can: - -- **Upload a Logo** - Upload your team's logo to be displayed instead of the default Documenso logo. -- **Set the Brand Website** - Enter the URL of your team's website to be displayed in the email communications sent by the team. -- **Add Additional Brand Details** - You can add additional information to display at the bottom of the emails sent by the team. This can include contact information, social media links, and other relevant details. diff --git a/apps/documentation/pages/users/teams/preferences.mdx b/apps/documentation/pages/users/teams/preferences.mdx deleted file mode 100644 index de0b7ca39..000000000 --- a/apps/documentation/pages/users/teams/preferences.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Preferences -description: Learn how to manage your team's global preferences. ---- - -# Preferences - -You can manage your team's global preferences by clicking on the **Preferences** tab in the team's settings dashboard. - -![A screenshot of the team's global preferences page](/teams/team-preferences.webp) - -The preferences page allows you to update the following settings: - -- **Document Visibility** - Set the default visibility of the documents created by team members. Learn more about [document visibility](/users/teams/document-visibility). -- **Default Document Language** - This setting allows you to set the default language for the documents uploaded in the team account. The default language is used as the default language in the email communications with the document recipients. You can change the language for individual documents when uploading them. -- **Sender Details** - Set whether the sender's name should be included in the emails sent by the team. Learn more about [sender details](/users/teams/sender-details). -- **Typed Signature** - It controls whether the document recipients can sign the documents with a typed signature or not. If enabled, the recipients can sign the document using either a drawn or a typed signature. If disabled, the recipients can only sign the documents usign a drawn signature. This setting can also be changed for individual documents when uploading them. -- **Include the Signing Certificate** - This setting controls whether the signing certificate should be included in the signed documents. If enabled, the signing certificate is included in the signed documents. If disabled, the signing certificate is not included in the signed documents. Regardless of this setting, the signing certificate is always available in the document's audit log page. -- **Branding Preferences** - Set the branding preferences and defaults for the team account. Learn more about [branding preferences](/users/teams/branding-preferences). diff --git a/apps/documentation/pages/users/teams/sender-details.mdx b/apps/documentation/pages/users/teams/sender-details.mdx deleted file mode 100644 index 196cd22e7..000000000 --- a/apps/documentation/pages/users/teams/sender-details.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Email Sender Details -description: Learn how to update the sender details for your team's email notifications. ---- - -## Sender Details - -If the **Sender Details** setting is enabled, the emails sent by the team will include the sender's name. The email will say: - -> "Example User" on behalf of "Example Team" has invited you to sign "document.pdf" - -If the **Sender Details** setting is disabled, the emails sent by the team will not include the sender's name. The email will say: - -> "Example Team" has invited you to sign "document.pdf" diff --git a/apps/documentation/public/developer-mode/field-coordinates.webp b/apps/documentation/public/developer-mode/field-coordinates.webp new file mode 100644 index 000000000..2089e8b15 Binary files /dev/null and b/apps/documentation/public/developer-mode/field-coordinates.webp differ diff --git a/apps/documentation/public/direct-links/documenso-profile.webp b/apps/documentation/public/direct-links/documenso-profile.webp index d0746f345..5a935a464 100644 Binary files a/apps/documentation/public/direct-links/documenso-profile.webp and b/apps/documentation/public/direct-links/documenso-profile.webp differ diff --git a/apps/documentation/public/email-domains/create-domain-dialog.webp b/apps/documentation/public/email-domains/create-domain-dialog.webp new file mode 100644 index 000000000..0e9c3bc70 Binary files /dev/null and b/apps/documentation/public/email-domains/create-domain-dialog.webp differ diff --git a/apps/documentation/public/email-domains/email-domain-sync.webp b/apps/documentation/public/email-domains/email-domain-sync.webp new file mode 100644 index 000000000..cd62cce21 Binary files /dev/null and b/apps/documentation/public/email-domains/email-domain-sync.webp differ diff --git a/apps/documentation/public/email-domains/email-domains-manage-create-email.webp b/apps/documentation/public/email-domains/email-domains-manage-create-email.webp new file mode 100644 index 000000000..d3aafb982 Binary files /dev/null and b/apps/documentation/public/email-domains/email-domains-manage-create-email.webp differ diff --git a/apps/documentation/public/email-domains/email-domains-manage.webp b/apps/documentation/public/email-domains/email-domains-manage.webp new file mode 100644 index 000000000..ec0dc9269 Binary files /dev/null and b/apps/documentation/public/email-domains/email-domains-manage.webp differ diff --git a/apps/documentation/public/email-domains/email-domains-record.webp b/apps/documentation/public/email-domains/email-domains-record.webp new file mode 100644 index 000000000..f69696799 Binary files /dev/null and b/apps/documentation/public/email-domains/email-domains-record.webp differ diff --git a/apps/documentation/public/email-domains/email-domains-settings-page.webp b/apps/documentation/public/email-domains/email-domains-settings-page.webp new file mode 100644 index 000000000..512c436a0 Binary files /dev/null and b/apps/documentation/public/email-domains/email-domains-settings-page.webp differ diff --git a/apps/documentation/public/get-started-images/add-team-2.webp b/apps/documentation/public/get-started-images/add-team-2.webp deleted file mode 100644 index 84260ab79..000000000 Binary files a/apps/documentation/public/get-started-images/add-team-2.webp and /dev/null differ diff --git a/apps/documentation/public/get-started-images/add-team-members-documenso.webp b/apps/documentation/public/get-started-images/add-team-members-documenso.webp deleted file mode 100644 index bd485d82c..000000000 Binary files a/apps/documentation/public/get-started-images/add-team-members-documenso.webp and /dev/null differ diff --git a/apps/documentation/public/get-started-images/add-team.webp b/apps/documentation/public/get-started-images/add-team.webp deleted file mode 100644 index 799ba3f81..000000000 Binary files a/apps/documentation/public/get-started-images/add-team.webp and /dev/null differ diff --git a/apps/documentation/public/organisations/organisation-branding.webp b/apps/documentation/public/organisations/organisation-branding.webp new file mode 100644 index 000000000..e28df3530 Binary files /dev/null and b/apps/documentation/public/organisations/organisation-branding.webp differ diff --git a/apps/documentation/public/organisations/organisation-document-preferences.webp b/apps/documentation/public/organisations/organisation-document-preferences.webp new file mode 100644 index 000000000..6f2548590 Binary files /dev/null and b/apps/documentation/public/organisations/organisation-document-preferences.webp differ diff --git a/apps/documentation/public/organisations/organisation-document-visibility.webp b/apps/documentation/public/organisations/organisation-document-visibility.webp new file mode 100644 index 000000000..054827e8e Binary files /dev/null and b/apps/documentation/public/organisations/organisation-document-visibility.webp differ diff --git a/apps/documentation/public/organisations/organisation-email-preferences.webp b/apps/documentation/public/organisations/organisation-email-preferences.webp new file mode 100644 index 000000000..a66e64316 Binary files /dev/null and b/apps/documentation/public/organisations/organisation-email-preferences.webp differ diff --git a/apps/documentation/public/organisations/organisation-group-assignment.webp b/apps/documentation/public/organisations/organisation-group-assignment.webp new file mode 100644 index 000000000..2ead5a1df Binary files /dev/null and b/apps/documentation/public/organisations/organisation-group-assignment.webp differ diff --git a/apps/documentation/public/organisations/organisation-group-create.webp b/apps/documentation/public/organisations/organisation-group-create.webp new file mode 100644 index 000000000..79f98a98d Binary files /dev/null and b/apps/documentation/public/organisations/organisation-group-create.webp differ diff --git a/apps/documentation/public/organisations/organisation-group-manage.webp b/apps/documentation/public/organisations/organisation-group-manage.webp new file mode 100644 index 000000000..e907e423d Binary files /dev/null and b/apps/documentation/public/organisations/organisation-group-manage.webp differ diff --git a/apps/documentation/public/organisations/organisations-basic-diagram.webp b/apps/documentation/public/organisations/organisations-basic-diagram.webp new file mode 100644 index 000000000..7f1a3da8b Binary files /dev/null and b/apps/documentation/public/organisations/organisations-basic-diagram.webp differ diff --git a/apps/documentation/public/organisations/organisations-billing.webp b/apps/documentation/public/organisations/organisations-billing.webp new file mode 100644 index 000000000..03e2cb15f Binary files /dev/null and b/apps/documentation/public/organisations/organisations-billing.webp differ diff --git a/apps/documentation/public/organisations/organisations-create.webp b/apps/documentation/public/organisations/organisations-create.webp new file mode 100644 index 000000000..f3c036365 Binary files /dev/null and b/apps/documentation/public/organisations/organisations-create.webp differ diff --git a/apps/documentation/public/organisations/organisations-member-invite.webp b/apps/documentation/public/organisations/organisations-member-invite.webp new file mode 100644 index 000000000..91fbeaa77 Binary files /dev/null and b/apps/documentation/public/organisations/organisations-member-invite.webp differ diff --git a/apps/documentation/public/public-profile/documenso-enable-public-profile-settings.webp b/apps/documentation/public/public-profile/documenso-enable-public-profile-settings.webp new file mode 100644 index 000000000..b37621a45 Binary files /dev/null and b/apps/documentation/public/public-profile/documenso-enable-public-profile-settings.webp differ diff --git a/apps/documentation/public/public-profile/documenso-public-profile-settings.webp b/apps/documentation/public/public-profile/documenso-public-profile-settings.webp index d7c6e1763..bfd4dfac7 100644 Binary files a/apps/documentation/public/public-profile/documenso-public-profile-settings.webp and b/apps/documentation/public/public-profile/documenso-public-profile-settings.webp differ diff --git a/apps/documentation/public/teams/document-visibility-settings.webp b/apps/documentation/public/teams/document-visibility-settings.webp index 7022a3584..d726efc77 100644 Binary files a/apps/documentation/public/teams/document-visibility-settings.webp and b/apps/documentation/public/teams/document-visibility-settings.webp differ diff --git a/apps/documentation/public/teams/team-create-dialog.webp b/apps/documentation/public/teams/team-create-dialog.webp new file mode 100644 index 000000000..25c4f1a5b Binary files /dev/null and b/apps/documentation/public/teams/team-create-dialog.webp differ diff --git a/apps/documentation/public/teams/team-create.webp b/apps/documentation/public/teams/team-create.webp new file mode 100644 index 000000000..1b1801805 Binary files /dev/null and b/apps/documentation/public/teams/team-create.webp differ diff --git a/apps/documentation/public/teams/team-preferences.webp b/apps/documentation/public/teams/team-preferences.webp deleted file mode 100644 index efb6f00f7..000000000 Binary files a/apps/documentation/public/teams/team-preferences.webp and /dev/null differ diff --git a/apps/documentation/public/webhook-images/test-webhook-dialog.webp b/apps/documentation/public/webhook-images/test-webhook-dialog.webp new file mode 100644 index 000000000..59cdbfead Binary files /dev/null and b/apps/documentation/public/webhook-images/test-webhook-dialog.webp differ diff --git a/apps/documentation/public/webhook-images/test-webhooks-page.webp b/apps/documentation/public/webhook-images/test-webhooks-page.webp new file mode 100644 index 000000000..b5b833ced Binary files /dev/null and b/apps/documentation/public/webhook-images/test-webhooks-page.webp differ diff --git a/apps/documentation/theme.config.tsx b/apps/documentation/theme.config.tsx index aa54b5c57..d6a0a6747 100644 --- a/apps/documentation/theme.config.tsx +++ b/apps/documentation/theme.config.tsx @@ -19,6 +19,22 @@ const themeConfig: DocsThemeConfig = { +