search

clerk / clerk-docs

The documentation content for Clerk, an authentication and user management platform.
https://clerk.com/docs
101 stars 396 forks source link

Invalid alert type [!INFO] in 'Verify the active user's permissions in an organization' documentation #1165

Closed bookercodes closed 3 months ago

bookercodes commented 3 months ago

In Verify the active user's permissions in an organization, under How to add types for roles and permissions, the alert references [!INFO], but [!INFO] not a support alert type:

image

I was about to submit a pull request, but I can't decide what alert type would be inline with the convention you use across the documentation.

I think it looks like a [!NOTE]. If what works for you, I'll make a PR .

kevinzunigacuellar commented 3 months ago

I agree that it should be a note as well.

The current explanation might be a bit tricky for some to follow. How about rephrasing it like this?

By default, roles and permission types like OrganizationCustomRoleKey and OrganizationCustomPermissionKey are assigned string. However, if you define a ClerkAuthorization type in your project, this will be used instead.