Skip to content

Commit 506d44f

Browse files
committed
Merge branch 'main' into im2nguyen/refactor-org-docs
2 parents f923717 + cdf782b commit 506d44f

File tree

168 files changed

+907
-908
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+907
-908
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -387,12 +387,12 @@ The `metadata` frontmatter field can be used to define additional information ab
387387

388388
<details>
389389
<summary>Define canonical or alternate URLs for your documentation page</summary>
390-
<br />
390+
<br />
391391
<p><strong>This is set via the <code>alternates</code> field. It has the following subfields:</strong></p>
392-
393-
| Name | Type | Default | Description |
394-
| ---------- | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
395-
| `canonical` | `string` | - | The canonical URL to avoid duplicate content across versions or domains. |
392+
393+
| Name | Type | Default | Description |
394+
| ----------- | -------- | ------- | ------------------------------------------------------------------------ |
395+
| `canonical` | `string` | - | The canonical URL to avoid duplicate content across versions or domains. |
396396

397397
```diff
398398
---
@@ -409,7 +409,7 @@ The `metadata` frontmatter field can be used to define additional information ab
409409

410410
<details>
411411
<summary>Configure Open Graph metadata for social media previews</summary>
412-
<br />
412+
<br />
413413
<p><strong>This is set via the <code>openGraph</code> field. It has the following subfields:</strong></p>
414414

415415
| Name | Type | Default | Description |
@@ -425,7 +425,7 @@ The `metadata` frontmatter field can be used to define additional information ab
425425
title: Example
426426
+ metadata:
427427
+ openGraph:
428-
+ title: Clerk organizations - invite users
428+
+ title: Clerk Organizations - invite users
429429
+ description: Guide to sending and managing invitations within Clerk.
430430
+ images:
431431
+ - https://example.com/social-preview.png
@@ -436,7 +436,7 @@ The `metadata` frontmatter field can be used to define additional information ab
436436

437437
<details>
438438
<summary>Define X Cards metadata for the page</summary>
439-
<br />
439+
<br />
440440
<p><strong>This is set via the <code>twitter</code> field. It has the following subfields:</strong></p>
441441

442442
| Name | Type | Default | Description |
@@ -450,7 +450,7 @@ The `metadata` frontmatter field can be used to define additional information ab
450450
title: Example
451451
+ metadata:
452452
+ twitter:
453-
+ title: Clerk organizations - invite users
453+
+ title: Clerk Organizations - invite users
454454
+ description: Guide to sending and managing invitations within Clerk.
455455
+ images:
456456
+ - https://example.com/social-preview.png
@@ -461,7 +461,7 @@ The `metadata` frontmatter field can be used to define additional information ab
461461

462462
<details>
463463
<summary>Control search engine indexing and crawler behavior.</summary>
464-
<br />
464+
<br />
465465
<p><strong>This is set via the <code>robots</code> field. It has the following subfields:</strong></p>
466466

467467
| Name | Type | Default | Description |
@@ -942,7 +942,7 @@ Tooltips are defined in the `_tooltips` folder and written in MDX, but they do n
942942
The tooltip syntax is similar to a link, but with a `!` prefix, as shown in the following example:
943943

944944
```mdx
945-
The ID of the [active organization](!active-organization) that the user belongs to.
945+
The ID of the [Active Organization](!active-organization) that the user belongs to.
946946
```
947947

948948
Tooltips should follow the same styleguide as links - only add them on the first mention of a term and only in the highest heading section. So if a term is mentioned in an H2 section and again in its H3 section, it doesn't need to be added in the H3 section.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Enable billing
1+
## Enable Billing
22

3-
To enable billing for your application, navigate to the [**Billing Settings**](https://dashboard.clerk.com/~/billing/settings) page in the Clerk Dashboard. This page will guide you through enabling billing for your application.
3+
To enable Billing for your application, navigate to the [**Billing Settings**](https://dashboard.clerk.com/~/billing/settings) page in the Clerk Dashboard. This page will guide you through enabling Billing for your application.
44

55
Clerk Billing costs the same as using Stripe Billing directly, just 0.7% per transaction, plus transaction fees which are paid directly to Stripe. Clerk Billing is **not** the same as Stripe Billing. Plans and pricing are managed directly through the Clerk Dashboard and won't sync with your existing Stripe products or plans. Clerk uses Stripe **only** for payment processing, so you don't need to set up Stripe Billing.
66

77
### Payment gateway
88

9-
Once you have enabled billing, you will see the following **Payment gateway** options for collecting payments via Stripe:
9+
Once you have enabled Billing, you will see the following **Payment gateway** options for collecting payments via Stripe:
1010

11-
- **Clerk development gateway**: A shared **test** Stripe account used for development instances. This allows developers to test and build billing flows **in development** without needing to create and configure a Stripe account.
11+
- **Clerk development gateway**: A shared **test** Stripe account used for development instances. This allows developers to test and build Billing flows **in development** without needing to create and configure a Stripe account.
1212
- **Stripe account**: Use your own Stripe account for production. **A Stripe account created for a development instance cannot be used for production**. You will need to create a separate Stripe account for your production environment.

docs/_partials/clerk-middleware-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
4646
- `organizationSyncOptions?`
4747
- <code>[OrganizationSyncOptions](#organization-sync-options) | undefined</code>
4848

49-
Used to activate a specific [organization](/docs/guides/organizations/overview) or [personal account](/docs/guides/dashboard/overview) based on URL path parameters. If there's a mismatch between the [active organization](!active-organization) in the session (e.g., as reported by [`auth()`](/docs/reference/nextjs/app-router/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.
49+
Used to activate a specific [Organization](/docs/guides/organizations/overview) or [Personal Account](/docs/guides/dashboard/overview) based on URL path parameters. If there's a mismatch between the [Active Organization](!active-organization) in the session (e.g., as reported by [`auth()`](/docs/reference/nextjs/app-router/auth)) and the Organization indicated by the URL, the middleware will attempt to activate the Organization specified in the URL.
5050

5151
---
5252

docs/_partials/clerk-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,5 @@
8686
- `taskUrls?`
8787
- `Record<SessionTask['key'], string>`
8888

89-
The URL paths users are redirected to after sign-up or sign-in when specific session tasks need to be completed. For example, `{ 'choose-organization': '/onboarding/choose-organization' }` redirects users to `/onboarding/choose-organization` after sign-up if they need to choose an organization.
89+
The URL paths users are redirected to after sign-up or sign-in when specific session tasks need to be completed. For example, `{ 'choose-organization': '/onboarding/choose-organization' }` redirects users to `/onboarding/choose-organization` after sign-up if they need to choose an Organization.
9090
</Properties>

docs/_partials/has-warning.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
> [!WARNING]
2-
> Using `has()` **on the server-side** to check permissions works only with **custom permissions**, as [system permissions](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) aren't included in the session token claims. To check system permissions, verify the user's role instead.
2+
> Using `has()` **on the server-side** to check Permissions works only with **Custom Permissions**, as [System Permissions](/docs/guides/organizations/control-access/roles-and-permissions#system-permissions) aren't included in the session token claims. To check System Permissions, verify the user's Role instead.

docs/_partials/nextjs/build-clerk-props.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { GetServerSideProps } from 'next'
66

77
export const getServerSideProps: GetServerSideProps = async (ctx) => {
88
// Use `getAuth()` to access `isAuthenticated` and the user's ID
9-
const { isAuthenticated } = getAuth(ctx.req)
9+
const { isAuthenticated, userId } = getAuth(ctx.req)
1010

1111
// Protect the route by checking if the user is signed in
1212
if (!isAuthenticated) {

docs/_partials/organization-sync-options.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ object has the type `OrganizationSyncOptions`, which has the following propertie
55
- `organizationPatterns`
66
- <code>[Pattern](#pattern)\[]</code>
77

8-
Specifies URL patterns that are organization-specific, containing an organization ID or slug as a path parameter. If a request
9-
matches this path, the organization identifier will be used to set that org as active.
8+
Specifies URL patterns that are Organization-specific, containing an Organization ID or slug as a path parameter. If a request matches this path, the Organization identifier will be used to set that Organization as active.
109

1110
If the route also matches the `personalAccountPatterns` prop, this prop takes precedence.
1211

13-
Patterns must have a path parameter named either `:id` (to match a Clerk organization ID) or `:slug` (to match a Clerk organization slug).
12+
Patterns must have a path parameter named either `:id` (to match a Clerk Organization ID) or `:slug` (to match a Clerk Organization slug).
1413

1514
> [!WARNING]
16-
> If the organization can't be activated—either because it doesn't exist or the user lacks access—the previously [active organization](!active-organization) will remain unchanged. Components must detect this case and provide an appropriate error and/or resolution pathway, such as calling `notFound()` or displaying an [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher).
15+
> If the Organization can't be activated—either because it doesn't exist or the user lacks access—the previously [Active Organization](!active-organization) will remain unchanged. Components must detect this case and provide an appropriate error and/or resolution pathway, such as calling `notFound()` or displaying an [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher).
1716
1817
Common examples:
1918

@@ -26,7 +25,7 @@ object has the type `OrganizationSyncOptions`, which has the following propertie
2625
- `personalAccountPatterns`
2726
- <code>[Pattern](#pattern)\[]</code>
2827

29-
URL patterns for resources that exist within the context of a user's [personal account](/docs/guides/organizations/configure#enable-organizations).
28+
URL patterns for resources that exist within the context of a user's [Personal Account](/docs/guides/organizations/configure#allow-personal-accounts).
3029

3130
If the route also matches the `organizationPattern` prop, the `organizationPattern` prop takes precedence.
3231

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
A user can be a member of multiple organizations, but only one can be active at a time. The **active organization** determines which organization-specific data the user can access and which role and related permissions they have within the organization.
1+
A user can be a member of multiple Organizations, but only one can be active at a time. The **Active Organization** determines which Organization-specific data the user can access and which Role and related Permissions they have within the Organization.

docs/_tooltips/session-tasks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
**Session tasks** are requirements that users must fulfill in order to complete the authentication process, such as choosing an organization.
1+
**Session tasks** are requirements that users must fulfill in order to complete the authentication process, such as choosing an Organization.

docs/getting-started/core-concepts.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Clerk provides three ways to integrate authentication into your application, dep
1313
1. **[Prebuilt components](/docs/reference/components/overview)**: All-in-one UI components that can be integrated into your application. They are fully customizable to match your application's branding and design. This is the recommended approach for most use cases.
1414
1. **[Custom flows using the Clerk API](/docs/guides/development/custom-flows/overview)**: Build your own UI using the Clerk API. This option provides maximum flexibility and control over the user experience but requires more development effort.
1515

16-
Clerk offers a comprehensive suite of prebuilt components designed to seamlessly integrate authentication and multi-tenancy into your application. Components, like `<SignIn />`, `<UserButton />`, and `<OrganizationSwitcher />`, are all-in-one solutions that handle the full lifecycle of the user experience, from sign-up/sign-in to user profile and organization management.
16+
Clerk offers a comprehensive suite of prebuilt components designed to seamlessly integrate authentication and multi-tenancy into your application. Components, like `<SignIn />`, `<UserButton />`, and `<OrganizationSwitcher />`, are all-in-one solutions that handle the full lifecycle of the user experience, from sign-up/sign-in to user profile and Organization management.
1717

1818
The Account Portal uses these components on dedicated pages that are hosted on Clerk servers. These pages cannot be customized beyond the options provided in the [Clerk Dashboard](https://dashboard.clerk.com/~/account-portal).
1919

@@ -32,7 +32,7 @@ For example, you can:
3232

3333
- Enable phone number authentication or multi-factor authentication.
3434
- Add social providers like Google.
35-
- Delete users or create organizations.
35+
- Delete users or create Organizations.
3636
- Invite other users to your [workspace](/docs/guides/dashboard/overview#workspaces) to help configure and manage your application.
3737

3838
To get started, see the [configuration docs](/docs/guides/configure/auth-strategies/sign-up-sign-in-options), which include dedicated guides for specific configuration options.
@@ -67,9 +67,9 @@ The [`User`](/docs/reference/javascript/user) object represents the current user
6767

6868
#### Organization
6969

70-
Organizations are a flexible and scalable way to manage users and their access to resources within your Clerk application. With organizations, you can assign specific roles and permissions to users, making them useful for managing projects, coordinating teams, or facilitating partnerships.
70+
Organizations are a flexible and scalable way to manage users and their access to resources within your Clerk application. With Organizations, you can assign specific Roles and Permissions to users, making them useful for managing projects, coordinating teams, or facilitating partnerships.
7171

72-
Users can belong to many organizations. One of them will be the [active organization](!active-organization) of the session. It is represented by the [`Organization`](/docs/reference/javascript/organization) object. To learn about organizations, see the [dedicated guide](/docs/guides/organizations/overview).
72+
Users can belong to many Organizations. One of them will be the [Active Organization](!active-organization) of the session. It is represented by the [`Organization`](/docs/reference/javascript/organization) object. To learn about Organizations, see the [dedicated guide](/docs/guides/organizations/overview).
7373

7474
#### Sign in
7575

0 commit comments

Comments
 (0)