-
-
Notifications
You must be signed in to change notification settings - Fork 144
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/654-deno-docs-improvements #655
Merged
Merged
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
MasterKale
added
package:browser
@simplewebauthn/browser
package:server
@simplewebauthn/server
package:types
@simplewebauthn/typescript-types
labels
Dec 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
package:browser
@simplewebauthn/browser
package:server
@simplewebauthn/server
package:types
@simplewebauthn/typescript-types
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.
This PR improves
deno docs
output with more and better JSDoc comments. This is an initial effort to make the docs at https://jsr.io/@simplewebauthn/server/doc and https://jsr.io/@simplewebauthn/browser/doc more useful.To this end, I've decided to retire @simplewebauthn/types and instead codegen these types into /browser and /server so they're code within those individual codebases. This will make types directly clickable in the docs links above, as
deno doc
(which JSR.io appears to use to render the docs for a given package) won't go into "third-party" packages and thus many of the types would remain unclickable.Fixes #654.
Breaking Changes
@typescript/types is being retired. Its types will now be included directly in @simplewebauthn/browser and @simplewebauthn/server. To refactor existing imports from /types, simply import them from /browser or /server instead:
Before:
After: