-
Notifications
You must be signed in to change notification settings - Fork 535
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: Machine Token Docs #1725
Open
Ben2W
wants to merge
9
commits into
main
Choose a base branch
from
ben/machine-tokens
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat: Machine Token Docs #1725
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hey, here’s your docs preview: https://clerk.com/docs/pr/1725 |
Ben2W
force-pushed
the
ben/machine-tokens
branch
from
November 21, 2024 00:40
f25d216
to
d6aa27f
Compare
Ben2W
force-pushed
the
ben/machine-tokens
branch
from
January 28, 2025 20:21
ff5ca46
to
155ff57
Compare
running prettier removing redundant ids a "valid" id was in fact - not valid removing unneccessary "s" reverting adding pages back in different folder some minor changes machine_id has a 255 character limit Some Colin Notes
Ben2W
force-pushed
the
ben/machine-tokens
branch
from
January 28, 2025 20:23
155ff57
to
cfb62cb
Compare
Hey, here’s your docs preview: https://clerk.com/docs/pr/1725 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently all customer-facing tokens are session tokens. We are adding
machine tokens
which is another customer-facing token. This PR adds documentation on:Additionally because now, all backend requests may no longer have a user + session associated with them, I modified the structure of some of the docs pages, and slightly edited existing pages to help fit the concept of "machine authentication". Read below to see what I changed.
Created the following machine request pages:
/docs/machine-requests/overview
/docs/machine-requests/machine-tokens
/docs/machine-requests/manual-jwt
Moved most of the "Backend Requests" pages to "Session Requests"
Calling this section "backend request" is confusing because machine requests are also backend requests.
This caused most of the "files changed" in the PR because a lot of links were changed from @NWylynko's script.
Some pages that were in "Backend Requests" didn't fit under "Session Requests," so they were moved to their own section:
Modified the following pages to add the concept of machine authentication:
Slack thread:
https://clerkinc.slack.com/archives/C01QFRQNHSN/p1738141182851989
Checklist