OAuth doc tweaks #56
Merged
OAuth doc tweaks #56
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
bnewbold
force-pushed
the
bnewbold/oauth-tweaks
branch
from
64dbf9b to
c3cf3c7
Compare
matthieusieben
approved these changes
Aug 9, 2024
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.
Updates markdown reference link format. The "just brackets" style (
[PROTOCOL]) does work in CommonMark and is called "shortcut reference link", but when I first looked in github markdown docs it wasn't described/specced anywhere so I updated everything in "collapsed referenced link" style ([PROTOCOL][]) or expanded ([Protocol][PROTOCOL]). I'd be fine with the "shortcut reference link" syntax in the future, but doesn't seem work re-updating this PR.The "title" string in quotes in the reference link definitions only shows up as "title" attribution not the text, unfortunately, so I updated a bunch of links with casing and/or terminology changes.
Lower-casing draft names is the norm in the IETF community so I went with that.
Updated
client_idexamples to be full URLs to a metadata JSON doc.Updated HTTP request snippets to use urlencoding more consistently. More technically correct though poor for readability.
Removed some refs which seemed unrelated, like Open Graph and some internal notion links.
Switched domain examples to not be
bskyin most cases, so this will read as more atproto-generic. Didn't update the reverse-domain app prefix examples as they are a good example there though.We should maybe have a Changelog section for this doc? but I just want to get these fixes through for now, history is in git.