Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[wip] reorging content and adding top-level sdk switching #1157

Draft
wants to merge 43 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
081aea3
start
kylemac May 2, 2024
2a1fb0f
progress
kylemac May 2, 2024
2543e20
more progress
kylemac May 2, 2024
51ab140
more progress
kylemac May 3, 2024
470fa76
add getting started stub
kylemac May 4, 2024
383aa59
stub in component manifest
kylemac May 4, 2024
a0ad6fa
add reference manifest
kylemac May 4, 2024
5f519da
a bunch of progress
kylemac May 5, 2024
4e1d25d
clean up reference manifest
kylemac May 5, 2024
28891ff
clean up components manifest
kylemac May 5, 2024
61b9635
clean up getting started manifest
kylemac May 5, 2024
357892c
add elements manifest
kylemac May 5, 2024
29ef1eb
add custom-flows manifest
kylemac May 5, 2024
ac06178
do a pass on guides manifest
kylemac May 5, 2024
dbf8178
add sdks to "api reference"
kylemac May 5, 2024
df3e300
punch up guides a bit more
kylemac May 5, 2024
9cd7909
add error reference to guides manifest
kylemac May 6, 2024
03a7be4
clean up upgrading clerk section
kylemac May 6, 2024
b0541f3
misc cleanup
kylemac May 6, 2024
6747fe1
move base path for getting-started to quickstarts
kylemac May 7, 2024
c7610cb
fix link in elements manifest
kylemac May 7, 2024
7e13934
rename reference to references to match dirs
kylemac May 7, 2024
ea5abc7
update manifest schema
bradlc May 7, 2024
29c074b
recover some icons in the new manifest format
kylemac May 7, 2024
6fc03b7
add icon back to aio nav item
kylemac May 7, 2024
f5d3496
finesse the elements manifest
kylemac May 7, 2024
5035828
add basic banner example
kylemac May 7, 2024
2d9ce72
stub out what an SDK reference could look like
kylemac May 7, 2024
09f639d
Merge branch 'main' into reorg
bradlc May 21, 2024
7a884ba
update manifest schema
bradlc May 21, 2024
7770c5b
Add `$schema` references
bradlc May 21, 2024
8d7db74
remove top-level items
bradlc May 21, 2024
7c030f2
Add branch `icon` property to manifest schema
bradlc May 22, 2024
e4b673e
lots of sdk progress
kylemac May 23, 2024
9e216a6
more sdk cleanup
kylemac May 23, 2024
9245aab
better links on manifest.ref
kylemac May 28, 2024
ad70506
update banner schema
bradlc May 30, 2024
abb9c18
add default banner to custom-flows section
kylemac May 30, 2024
e2153b1
unify use of danger callout in custom flows
kylemac May 30, 2024
7a06d9f
stash
kylemac Jun 12, 2024
8e520fa
begin top-level sdk switching reorg
kylemac Jun 12, 2024
a2e946d
prep react guides variant
kylemac Jun 12, 2024
d621498
add refs for all core concepts for react
kylemac Jun 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
584 changes: 584 additions & 0 deletions docs/copy.manifest.guides.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/custom-flows/bot-sign-up-protection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to use the Smart Bot Protection widget in your custom sig

# Smart bot sign-up protection

<Callout type="warning">
<Callout type="danger">
The simplest way to take advantage of [Bot Protection](/docs/security/bot-protection) for your Sign ups is by using our all-in-one [`<SignUp />` component](/docs/components/authentication/sign-up). This page describes how to implement Bot Protection if you are rebuilding your Sign Up view entirely from scratch using Clerk.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/custom-flows/email-sms-otp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how build a custom email or SMS one time code (OTP) authentic

# Build a custom email or SMS OTP authentication flow

<Callout type="warning">
<Callout type="danger">
This guide is for users who want to build a *custom* user interface using the Clerk API. To authenticate users with one-time passwords using a *prebuilt* UI, you should use Clerk's [Account Portal pages](/docs/account-portal/overview) or [prebuilt components](/docs/components/overview).
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/custom-flows/multi-session-applications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to use the Clerk API to add multi-session handling to you

# Build a custom multi-session flow

<Callout type="warning">
<Callout type="danger">
This guide is for users who want to build a *custom* user interface using the Clerk API. To implement multi-session handling with a *prebuilt* UI, you should use Clerk's [`<UserButton />`](/docs/components/user/user-button) component.
</Callout>

Expand Down
2 changes: 1 addition & 1 deletion docs/custom-flows/passkeys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to allow your users authenticate with passkeys with Clerk

# Build a custom authentication flow using passkeys

<Callout type="warning">
<Callout type="danger">
This guide is for users who want to build a *custom* user interface using the Clerk API. To authenticate users with passkeys using a *prebuilt* UI, you should use Clerk's [`<SignIn />`](/docs/components/authentication/sign-in) and [`<UserProfile />`](/docs/components/user/user-profile) components. See [the sign-in and sign-out options docs](/docs/authentication/configuration/sign-up-sign-in-options#passkeys) to learn more.
</Callout>

Expand Down
14 changes: 14 additions & 0 deletions docs/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Overview
description: Guides covering how to build or work with parts of Clerk
---

# Clerk Guides

The following guides will cover ways to configure or build your Clerk powered application.

## Guides

* [Implement basic Role Based Access Control (RBAC) with metadata](/docs/guides/basic-rbac)
* [Hide Personal Accounts and force organizations](/docs/guides/force-organizations)
* [Migrating to Clerk from Auth.js](/docs/guides/authjs-migration)
226 changes: 226 additions & 0 deletions docs/manifest.components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
{
"$schema": "./manifest.schema.json",
"navigation": [
[
{
"title": "Component Types",
"items": [
[
{
"title": "All in one",
"href": "/docs/components/overview",
"icon": "box"
},
{
"title": "Elements",
"tag": "(Beta)",
"href": "/docs/elements/overview",
"icon": "application-2"
}
]
]
},
{
"title": "Featured",
"items": [
[
{
"title": "`<ClerkProvider />`",
"href": "/docs/components/clerk-provider"
},
{
"title": "`<SignIn />`",
"href": "/docs/components/authentication/sign-in"
},
{
"title": "`<SignUp />`",
"href": "/docs/components/authentication/sign-up"
}
]
]
},
{
"title": "Component Reference",
"items": [
[
{
"title": "Authentication Components",
"collapse": true,
"items": [
[
{
"title": "`<SignIn />`",
"href": "/docs/components/authentication/sign-in"
},
{
"title": "`<SignUp />`",
"href": "/docs/components/authentication/sign-up"
}
]
]
},
{
"title": "User Components",
"collapse": true,
"items": [
[
{
"title": "`<UserButton />`",
"href": "/docs/components/user/user-button"
},
{
"title": "`<UserProfile />`",
"href": "/docs/components/user/user-profile"
}
]
]
},
{
"title": "Organization Components",
"collapse": true,
"items": [
[
{
"title": "`<CreateOrganization />`",
"href": "/docs/components/organization/create-organization"
},
{
"title": "`<OrganizationProfile />`",
"href": "/docs/components/organization/organization-profile"
},
{
"title": "`<OrganizationSwitcher />`",
"href": "/docs/components/organization/organization-switcher"
},
{
"title": "`<OrganizationList />`",
"href": "/docs/components/organization/organization-list"
}
]
]
},
{
"title": "Button Components",
"collapse": true,
"items": [
[
{
"title": "`<SignInButton />`",
"href": "/docs/components/unstyled/sign-in-button"
},
{
"title": "`<SignUpButton />`",
"href": "/docs/components/unstyled/sign-up-button"
},
{
"title": "`<SignOutButton />`",
"href": "/docs/components/unstyled/sign-out-button"
}
]
]
},
{
"title": "Control Components",
"collapse": true,
"items": [
[
{
"title": "`<AuthenticateWithRedirectCallback />`",
"wrap": false,
"href": "/docs/components/control/authenticate-with-callback"
},
{
"title": "`<ClerkLoaded>`",
"wrap": false,
"href": "/docs/components/control/clerk-loaded"
},
{
"title": "`<ClerkLoading>`",
"wrap": false,
"href": "/docs/components/control/clerk-loading"
},
{
"title": "`<Protect>`",
"wrap": false,
"href": "/docs/components/protect"
},
{
"title": "`<MultisessionAppSupport>`",
"wrap": false,
"href": "/docs/components/control/multi-session"
},
{
"title": "`<RedirectToSignIn />`",
"wrap": false,
"href": "/docs/components/control/redirect-to-signin"
},
{
"title": "`<RedirectToSignUp />`",
"wrap": false,
"href": "/docs/components/control/redirect-to-signup"
},
{
"title": "`<RedirectToUserProfile />`",
"wrap": false,
"href": "/docs/components/control/redirect-to-userprofile"
},
{
"title": "`<RedirectToOrganizationProfile />`",
"wrap": false,
"href": "/docs/components/control/redirect-to-organizationprofile"
},
{
"title": "`<RedirectToCreateOrganization />`",
"wrap": false,
"href": "/docs/components/control/redirect-to-createorganization"
},
{
"title": "`<SignedIn>`",
"wrap": false,
"href": "/docs/components/control/signed-in"
},
{
"title": "`<SignedOut>`",
"wrap": false,
"href": "/docs/components/control/signed-out"
}
]
]
}
]
]
},
{
"title": "Customization",
"items": [
[
{
"title": "Appearance Prop",
"href": "/docs/components/clerk-provider"
},
{
"title": "Localization (i18n)",
"href": "/docs/components/customization/localization"
},
{
"title": "Extending Clerk Components",
"collapse": true,
"items": [
[
{
"title": "Extending `<UserProfile />`",
"href": "/docs/components/customization/user-profile"
},
{
"title": "Extending `<OrganizationProfile />`",
"href": "/docs/components/customization/organization-profile"
}
]
]
}
]
]
}
]
]
}
80 changes: 80 additions & 0 deletions docs/manifest.custom-flows.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"$schema": "./manifest.schema.json",
"banner": {
"type": "caution",
"title": "Advanced",
"text": "Custom Flows are for advanced use cases that require extreme levels of control. Clerk provides better out-of-the-box functionality when using our prebuilt UI components.",
"cta": "View UI Components",
"href": "/docs/ui-components/overview"
},
"navigation": [
[
{
"title": "⚠ Rebuilding existing Clerk flows",
"href": "/docs/custom-flows/overview"
},
{
"title": "From scratch",
"items": [
[
{
"title": "`useSignUp()` and `useSignIn()`",
"href": "/docs/custom-flows/use-sign-up"
},
{
"title": "Email & Password",
"href": "/docs/custom-flows/email-password"
},
{
"title": "Email / SMS OTP",
"href": "/docs/custom-flows/email-sms-otp"
},
{
"title": "Email links",
"href": "/docs/custom-flows/email-links"
},
{ "title": "Multifactor", "href": "/docs/custom-flows/mfa" },
{ "title": "Passkeys", "href": "/docs/custom-flows/passkeys" },
{
"title": "OAuth Connections",
"href": "/docs/custom-flows/oauth-connections"
},
{
"title": "SAML Connections",
"href": "/docs/custom-flows/saml-connections"
},
{
"title": "Forgot Password",
"href": "/docs/custom-flows/forgot-password"
},
{ "title": "Sign out", "href": "/docs/custom-flows/sign-out" },
{
"title": "Invitations",
"href": "/docs/custom-flows/invitations"
},
{
"title": "Embedded Email Links",
"href": "/docs/custom-flows/embedded-email-links"
},
{
"title": "Multi-session applications",
"href": "/docs/custom-flows/multi-session-applications"
},
{
"title": "Error handling",
"href": "/docs/custom-flows/error-handling"
},
{
"title": "User Impersonation",
"href": "/docs/custom-flows/user-impersonation"
},
{
"title": "Bot sign-up protection",
"href": "/docs/custom-flows/bot-sign-up-protection"
}
]
]
}
]
]
}
Loading