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.

Sign up for GitHub

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

Jump to bottom

feat(vue,nuxt): Add Vue and Nuxt SDK docs #1710

Merged
merged 26 commits into from
Dec 20, 2024
Merged

feat(vue,nuxt): Add Vue and Nuxt SDK docs #1710

merged 26 commits into from
Dec 20, 2024

Conversation

wobsoriano
Copy link
Member

@wobsoriano wobsoriano commented Nov 14, 2024 •
edited
Loading

Important

🔎 Vue Previews:

🔎 Nuxt Previews:

Explanation:

  • We are launching an official Vue SDK for Clerk! 🎉
  • We need to show how to migrate from existing community SDK to the official one

This PR:

  • Is the base branch of other Vue SDK docs PRs
  • Adds SDK References Overview page
  • Adds community SDK to official SDK migration guide
  • Sets the foundation for next PRs (client-side helpers, dead links for now)

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • I have added the "deploy-preview" label and added the preview link(s) to this PR description
  • All existing checks pass

@github-actions GitHub Actions
Copy link

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

@wobsoriano wobsoriano changed the title docs(vue): Add overview, migration guide and sidebar links feat(vue): Add overview, migration guide and sidebar links Nov 15, 2024
@wobsoriano wobsoriano marked this pull request as ready for review November 15, 2024 03:26
@wobsoriano wobsoriano requested a review from a team as a code owner November 15, 2024 03:26
@wobsoriano wobsoriano mentioned this pull request Nov 25, 2024
Merged
3 tasks
@victoriaxyz
Copy link
Contributor

victoriaxyz commented Dec 12, 2024 •
edited
Loading

Hey @wobsoriano! Here's the updates: fe61e86 and 1aec4f4

Update

  • docs/references/vue/overview.mdx: reorganize and rewrite doc
  • docs/references/vue/migrating-from-vue-community-sdk.mdx: refactor composable section into steps

Note

  • docs/references/vue/migrating-from-vue-community-sdk.mdx: need link for "official support for Vue"
  • docs/references/vue/overview.mdx:
    • need link to “Nuxt docs” in important callout and "Nuxt SDK"
    • add custom composables methods (maybe)

@wobsoriano wobsoriano requested a review from a team as a code owner December 13, 2024 18:44
@alexisintech alexisintech force-pushed the rob/eco-224-vue-sdk-references branch from 7dfe83e to 32fa402 Compare December 13, 2024 20:49
@alexisintech
Copy link
Member

I've removed the "prebuilt components" section from the overview - almost all of our SDKs have access to the prebuilt components, thats a given. I don't think we need to include that under "key features". key features is moreso for features are key to the vue sdk (and probably not found in other sdks)

@alexisintech alexisintech force-pushed the rob/eco-224-vue-sdk-references branch from 32fa402 to 7954eae Compare December 13, 2024 21:05
wobsoriano and others added 2 commits December 16, 2024 07:50
@wobsoriano @victoriaxyz @alexisintech
feat(vue): Add client-side helpers (#1711)
fd2ab5c 
Co-authored-by: victoria <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
@wobsoriano @victoriaxyz @alexisintech
feat(vue): Add client helpers (part 2) (#1712)
b9c2e0e 
Co-authored-by: victoria <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
@wobsoriano wobsoriano changed the title feat(vue): Add overview, migration guide and sidebar links feat(vue): Add Vue SDK docs Dec 16, 2024
@alexisintech
Copy link
Member

needs nuxt docs in order to pass lint checks

@wobsoriano
Copy link
Member Author

needs nuxt docs in order to pass lint checks

Yes. Both Vue and Nuxt SDK will be announced together so I figured we merge them as one

victoriaxyz
victoriaxyz reviewed Dec 16, 2024
View reviewed changes
docs/references/vue/use-auth.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-auth.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-user.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-user.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-user.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-session.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-auth.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-session.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-sign-in.mdx Outdated Show resolved Hide resolved
docs/references/vue/use-sign-up.mdx Outdated Show resolved Hide resolved
@victoriaxyz
Copy link
Contributor

victoriaxyz commented Dec 16, 2024 •
edited
Loading

Commit to align Vue and React docs: 7dd3ba6

Related PR: #1814

The lint error is due to the Nuxt docs link. I'm currently working on the Nuxt docs.

@wobsoriano wobsoriano mentioned this pull request Dec 17, 2024
Merged
9 tasks
@wobsoriano wobsoriano changed the title feat(vue): Add Vue SDK docs feat(vue): Add Vue and Nuxt SDK docs Dec 20, 2024
@wobsoriano wobsoriano changed the title feat(vue): Add Vue and Nuxt SDK docs feat(vue,nuxt): Add Vue and Nuxt SDK docs Dec 20, 2024
alexisintech
alexisintech approved these changes Dec 20, 2024
View reviewed changes
Copy link
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

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

thanks so much for all of the collaboration! 😸💖

@wobsoriano wobsoriano requested a review from mwickett December 20, 2024 22:36
@wobsoriano wobsoriano merged commit 0c43cde into main Dec 20, 2024
4 checks passed
@wobsoriano wobsoriano deleted the rob/eco-224-vue-sdk-references branch December 20, 2024 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@victoriaxyz victoriaxyz victoriaxyz approved these changes

@alexisintech alexisintech alexisintech approved these changes

@mwickett mwickett mwickett approved these changes

Assignees
No one assigned
Labels
deploy-preview
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@wobsoriano @victoriaxyz @alexisintech @mwickett