feat: Add section for organization slug #2672
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
LauraBeatris
force-pushed
the
laura/orgs-931-update-documentation-guide-for-use-organization-slugs-in
branch
from
dfffe97 to
96b27b0
Compare
|
Note for reviewer: We still need to enable this feature on staging, which will be done on Monday, but I've opened for a first review on the copy itself. |
LauraBeatris
force-pushed
the
laura/orgs-931-update-documentation-guide-for-use-organization-slugs-in
branch
from
96b27b0 to
bc32380
Compare
| If disabled, organization slugs won't be displayed in the [`<CreateOrganization />`](/docs/reference/components/organization/create-organization), [`<OrganizationList />`](/docs/reference/components/organization/organization-list), and [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) components. | ||
|
|
||
| > [!IMPORTANT] | ||
| > Organization slugs are disabled by default for applications created after 10-06-2025. For applications created before this date, you can opt to disable it. |
There was a problem hiding this comment.
What's the rules with date formats? I can see some places in the docs where the numeric format is used and others where the written format ("October 6, 2025") is used. Personally, I prefer the written format as diff countries have diff numeric formats for dates. But yeah curious on this one @alexisintech ?
There was a problem hiding this comment.
I agree with written format!
There was a problem hiding this comment.
Speaking from my past role, I'd +1 the written out format too. It's the safest default.
If we change this one to October 6, 2025, can we update the 08-22-2025 right above this too on line 68 for consistency?
Note
If we wanted to get crazy fancy, we could create a <Date> component that uses Date.prototype.toLocaleDateString() to format the date in the reader's preference.
There was a problem hiding this comment.
Done: Change date to written format.
I like the idea of the <Date> component in the long run @manovotny!
There was a problem hiding this comment.
LOL! You did something different than what you suggested. October 6, 2025 ≠ October 6th, 2025.
It's @alexisintech's call, but IMO, I wouldn't use nd, th, etc in the dates.
There was a problem hiding this comment.
Remove the nd and th. @alexisintech let me know what you think!
There was a problem hiding this comment.
agree, just use numbers.
the date component could be cool - wanna create a ticket @manovotny
There was a problem hiding this comment.
the date component could be cool - wanna create a ticket @manovotny
|
LGTM @LauraBeatris - I have submitted a docs review that does the following:
Left a comment for the date format as I'm not sure what the rules are. Keen for @alexisintech to have a look at this one too! |
|
@SarahSoutoul @alexisintech I've followed the date patterns from existing callouts that use that "created after" terms, but let me know if there's a different/better way to include it. |
…r-use-organization-slugs-in
…r-use-organization-slugs-in
|
|
||
| To enable it, navigate to the [**Organizations Settings**](https://dashboard.clerk.com/last-active?path=organizations-settings) page in the Clerk Dashboard. | ||
|
|
||
| If disabled, organization slugs won't be displayed in the [`<CreateOrganization />`](/docs/reference/components/organization/create-organization), [`<OrganizationList />`](/docs/reference/components/organization/organization-list), and [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) components. |
There was a problem hiding this comment.
I think it's a given that if org slugs are disabled, they won't appear for an application. because they are disabled.
It'd make more sense to tell users what the behavior will be if they enable the feature.
| If disabled, organization slugs won't be displayed in the [`<CreateOrganization />`](/docs/reference/components/organization/create-organization), [`<OrganizationList />`](/docs/reference/components/organization/organization-list), and [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) components. | |
| When enabled, organization slugs will be displayed in the [`<CreateOrganization />`](/docs/reference/components/organization/create-organization), [`<OrganizationList />`](/docs/reference/components/organization/organization-list), and [`<OrganizationSwitcher />`](/docs/reference/components/organization/organization-switcher) components. |
There was a problem hiding this comment.
Love the change in phrasing from negative to positive.
…r-use-organization-slugs-in
🔎 Previews:
What does this solve?
We've introduced a new setting for enabling the organization slug. This PR introduces a section on organizations overview, clarifying about this setting and the behavior on AIOs.
Checklist