Skip to content
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 26 commits into from
Dec 9, 2024
Merged

Conversation

MasterKale
Copy link
Owner

@MasterKale MasterKale commented Dec 6, 2024

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:

import type {
  AuthenticationResponseJSON,
  RegistrationResponseJSON,
  WebAuthnCredential,
} from '@simplewebauthn/types';  // <--

After:

import type {
  AuthenticationResponseJSON,
  RegistrationResponseJSON,
  WebAuthnCredential,
} from '@simplewebauthn/server';  // <--

@MasterKale MasterKale marked this pull request as ready for review December 8, 2024 22:57
@MasterKale MasterKale added this to the v12.1.0 milestone Dec 8, 2024
@MasterKale MasterKale added package:browser @simplewebauthn/browser package:server @simplewebauthn/server package:types @simplewebauthn/typescript-types labels Dec 8, 2024
@MasterKale MasterKale merged commit 4fe6392 into master Dec 9, 2024
2 checks passed
@MasterKale MasterKale deleted the feat/654-deno-docs-improvements branch December 9, 2024 01:07
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate using deno doc for docs generation
1 participant