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: Add Fastify reference docs #1869

Merged

Conversation

LekoArts
Copy link
Member

@LekoArts LekoArts commented Jan 9, 2025

Explanation:

  • Add Fastify to the /docs index page inside the "Backend framework" section
  • Add Fastify reference documentation
  • Add Fastify to sidebar
  • Update Fastify quickstart to put one heading into reference docs

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

Copy link

github-actions bot commented Jan 9, 2025

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

@LekoArts LekoArts marked this pull request as ready for review January 9, 2025 14:52
@LekoArts LekoArts requested a review from a team as a code owner January 10, 2025 08:49
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.

Hi @LekoArts! Looks good. I reorganized the methods, rewrote intros to code examples, added clearer titles. See here: eda1863

Let me know what you think!

@LekoArts
Copy link
Member Author

Thanks for the edit, makes sense! I copied some sentences from https://github.com/clerk/clerk-docs/blob/main/docs/references/express/overview.mdx so we could also carry over those improvements into #1880 if you have to touch that file anyways.

@victoriaxyz
Copy link
Contributor

victoriaxyz commented Jan 14, 2025

@LekoArts Updated this PR: 2493658

Thanks for the edit, makes sense! I copied some sentences from https://github.com/clerk/clerk-docs/blob/main/docs/references/express/overview.mdx so we could also carry over those improvements into #1880 if you have to touch that file anyways.

Updated: 547ebef

docs/references/fastify/overview.mdx Outdated Show resolved Hide resolved
docs/references/fastify/overview.mdx Outdated Show resolved Hide resolved
docs/references/fastify/overview.mdx Outdated Show resolved Hide resolved
docs/references/fastify/overview.mdx Outdated Show resolved Hide resolved
@alexisintech
Copy link
Member

can we get Fastify get added as an option in the dropdown in the Clerk Dashboard?

@alexisintech
Copy link
Member

I've committed my final review!

  • moved the getAuth() example into a partial so that we can use it in the quickstart and the overview
  • moved clerkOptions into a partial to use in both the backend sdk docs (where we document createClerkClient options) and the fastify overview (where we document the clerkPlugin options)
  • deleted docs/backend-requests/handling/js-backend-sdks.mdx - I'm just not sure why this guide got created. it seems like repetitive information that doesn't deserve a separate guide. if users need to see how to make requests using one of the sdks, they can go to that sdk's reference docs...
  • Quickstart doc:
    • aligned copy with the copy used in other quickstarts, such as "Run the following command to install the SDK:"
    • updated the section title "Use getAuth() to access the auth state and protect routes" to "Protect your routes using getAuth()" to match other quickstarts (express also has a section titled Protect your routes using requireAuth())
    • added missing info about introducing the getAuth() helper, as this will be the first time user's are coming across this helper, we should explain what it is/does before showing an example.
    • added the getAuth() partial
  • Overview doc:
    • removed "methods" heading, as its unnecessary and we don't do this anywhere else.
    • moved sections around to make more sense. the structure is now as follows:
      • introduce clerkplugin
        • examples of how to register it
        • clerkplugin() options
          • example of how to use options
      • getauth()
  • updated the fastify repo to align with the docs

@alexisintech alexisintech force-pushed the lekoarts/eco-291-add-fastify-to-clerks-reference-docs branch from bc8f807 to 13fd927 Compare January 15, 2025 20:21
@victoriaxyz
Copy link
Contributor

can we get Fastify get added as an option in the dropdown in the Clerk Dashboard?

@LekoArts, in case you missed this comment.

@LekoArts
Copy link
Member Author

LekoArts commented Jan 17, 2025

Sure, I can add it 👍 But that shouldn't block this PR, right? I assume we can merge it now?

Edit: Done: https://github.com/clerk/dashboard/pull/4424

@victoriaxyz victoriaxyz self-requested a review January 17, 2025 16:02
@alexisintech alexisintech merged commit e7eab1b into main Jan 17, 2025
4 checks passed
@alexisintech alexisintech deleted the lekoarts/eco-291-add-fastify-to-clerks-reference-docs branch January 17, 2025 22:05
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.

3 participants