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

feat: Introduce Waitlist component docs #1696

Merged

Conversation

Copy link

Hey, here’s your docs preview: https://clerk.com/docs/pr/1696

@nikospapcom nikospapcom force-pushed the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch 2 times, most recently from dfe4573 to f12fde7 Compare November 12, 2024 08:53
@nikospapcom nikospapcom marked this pull request as ready for review November 12, 2024 11:54
@nikospapcom nikospapcom requested a review from a team as a code owner November 12, 2024 11:54
Comment on lines 20 to 21
> [!NOTE]
> The `<Waitlist />` component is only available in Core 2. If you are using Next.js is available after <code>@clerk/nextjs\@6.2.0</code>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to mention the Core 2 part, because the users are in the Core 2 docs. Core 1 users would be in the Core 1 docs, where none of this would exist because these features don't exist in Core 1.

Do you mean to mention that the Waitlist component will only work with Next.js versions 6.2.0 and above?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to mention the Core 2 part, because the users are in the Core 2 docs. Core 1 users would be in the Core 1 docs, where none of this would exist because these features don't exist in Core 1.

Do you mean to mention that the Waitlist component will only work with Next.js versions 6.2.0 and above?

@alexisintech sure I'll remove the reference for Core 2
about nextjs package yes it's available from 6.2.0 and above. The reason is because Waitlist is a totally new component and we can't export in the previous nextjs versions

docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/clerk.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/clerk.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
@alexisintech
Copy link
Member

We are removing all JavaScript <script> examples from the Docs.
Please remove the <CodeBlockTabs /> and the <script> examples! And only keep the npm-module examples

@nikospapcom nikospapcom force-pushed the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch 2 times, most recently from adf34a7 to 8787324 Compare November 13, 2024 08:22
docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
Comment on lines 222 to 233
{
"title": "Waitlist Components",
"items": [
[
{
"title": "`<Waitlist />`",
"wrap": false,
"href": "/docs/components/waitlist/overview"
}
]
]
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think about putting this under the "Authentication components" aka /components/authentication ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that it's the correct section because waitlist as a term is before authentication :) open to discuss it if you have time

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will there ever be other sign-up mode components? maybe we can rename the section to "Sign-up mode components"

If not, then I suppose we should change to "Waitlist component". Not plural components, because there's only one component.

@nikospapcom nikospapcom force-pushed the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch from 4bfd6a9 to 6d18038 Compare November 14, 2024 10:33
docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/components/authentication/sign-in.mdx Outdated Show resolved Hide resolved
Comment on lines 222 to 233
{
"title": "Waitlist Components",
"items": [
[
{
"title": "`<Waitlist />`",
"wrap": false,
"href": "/docs/components/waitlist/overview"
}
]
]
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will there ever be other sign-up mode components? maybe we can rename the section to "Sign-up mode components"

If not, then I suppose we should change to "Waitlist component". Not plural components, because there's only one component.

docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
@nikospapcom nikospapcom force-pushed the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch from e54fca5 to 320a42a Compare November 15, 2024 10:09
docs/components/authentication/sign-in.mdx Outdated Show resolved Hide resolved
docs/components/clerk-provider.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
@alexisintech
Copy link
Member

I think its all good! I just wanna get Victoria's review, and then we can approve :)

docs/authentication/configuration/restrictions.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@victoriaxyz victoriaxyz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor changes

docs/components/authentication/sign-in.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/clerk.mdx Outdated Show resolved Hide resolved
docs/customization/account-portal/overview.mdx Outdated Show resolved Hide resolved
docs/references/javascript/clerk/waitlist-methods.mdx Outdated Show resolved Hide resolved
docs/components/waitlist/overview.mdx Outdated Show resolved Hide resolved
@alexisintech
Copy link
Member

you can merge whenever :)

nikospapcom and others added 27 commits November 20, 2024 11:30
@nikospapcom nikospapcom force-pushed the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch from 2cc400a to 1d12c85 Compare November 20, 2024 09:31
@nikospapcom nikospapcom merged commit 72000ad into main Nov 20, 2024
4 checks passed
@nikospapcom nikospapcom deleted the nikospap/user-620-add-docs-about-the-waitlist-sign-up-mode branch November 20, 2024 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants