clerk / clerk-docs

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

Update User Backend SDK docs to match BAPI docs; add clerk/javascript file to every Backend SDK method doc #1213

Open alexisintech opened 4 days ago

alexisintech commented 4 days ago

[!IMPORTANT] 🔎 Previews:

-

Explanation:

While checking that our /backend/* reference docs were up to date (due to this linear ticket), I tracked which files are present by adding their corresponding clerk/javascript file in a comment on their respective page. This helped me find multiple missing methods (see the previously tagged linear ticket).

Also, adding these links will make it easy to find where these methods exist in the clerk/javascript repo when updating their respective pages.

For example, the source code for /backend/allowlist/create-allowlist-identifier exists at clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/AllowlistIdentifierApi.ts#L22 so I added a comment on this doc with a link to this file.


Also, while checking that our Backend SDK docs match our BAPI docs, I am updating one sub-api at a time. This PR serves to update the User sub-api.