WebAuthN Docs: add descriptions and details for PublicKey credential creation #24813
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
jsmrcaga
requested review from
sideshowbarker
and removed request for
a team
|
Preview URLs Flaws (7)URL:
External URLs (1)URL:
(comment last updated: 2023-02-25 10:16:12) |
sideshowbarker
approved these changes
Feb 25, 2023
|
Jo, thanks much, and congrats on landing your first docs change here — welcome aboard 🎉 |
|
@sideshowbarker thanks a lot! |
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.
Description
This Pull Request adds details on the
CredentailsContainerpage. More specifically, it adds descriptions for the possible options used underpublicKeywhen requesting the creation of a new credential. These have been taken directly from the W3C specification.Motivation
I have integrated WebAuthN three different times, and the three times I have needed to navigate between dev articles, blog posts, W3C docs and MDN. I would like other developers to be able to find the necessary information (or official links) faster and in a more straightforward manner.
Additional details
I have not been able to find more information on Federated and Password credential creation, although there is another PR for federated docs. I will certainly create a new PR with descriptions for the
getmethod soon.I'm also getting a formatting artifact when rendering locally because of the colon preceding the description. Please let me know if this is a local issue and if I need to take any steps to fix it.
Related issues and pull requests