Skip to content

Conversation

@0xsatoshi99
Copy link
Contributor

Summary

Adds MDN documentation links for all 8 Web Crypto API examples, completing the 6-year-old request in issue #40.

Changes

Updated web-crypto/README.md to include links to all examples:

Added links for 6 missing examples:

Kept existing links:

  • encrypt-decrypt
  • sign-verify

Before

Only 2 examples were listed:

* [sign/verify](sign-verify/index.html)
* [encrypt/decrypt](encrypt-decrypt/index.html)

After

All 8 examples are now listed with MDN links:

* [derive-bits](derive-bits/index.html)
* [derive-key](derive-key/index.html)
* [encrypt/decrypt](encrypt-decrypt/index.html)
* [export-key](export-key/index.html)
* [import-key](import-key/index.html)
* [sign/verify](sign-verify/index.html)
* [unwrap-key](unwrap-key/index.html)
* [wrap-key](wrap-key/index.html)

Benefits

  1. Complete Documentation: All examples now have links
  2. Better Discoverability: Users can find all 8 examples
  3. Direct API Reference: Each example links to its MDN API page
  4. Consistent Format: Follows the existing pattern

Checklist from #40

  • Add link to derive-bits example
  • Add link to derive-key example
  • Add links to encrypt-decrypt example (already existed)
  • Add link to export-key example
  • Add link to import-key example
  • Add links to sign-verify example (already existed)
  • Add links to unwrap-key example
  • Add link to wrap-key example

Fixes #40

Adds MDN documentation links for all 8 Web Crypto API examples,
completing the 6-year-old request in issue mdn#40.

Changes:
- Added link to derive-bits example (SubtleCrypto.deriveBits)
- Added link to derive-key example (SubtleCrypto.deriveKey)
- Added link to export-key example (SubtleCrypto.exportKey)
- Added link to import-key example (SubtleCrypto.importKey)
- Added link to unwrap-key example (SubtleCrypto.unwrapKey)
- Added link to wrap-key example (SubtleCrypto.wrapKey)
- Kept existing links for encrypt-decrypt and sign-verify

All examples now link to their corresponding MDN API documentation pages,
making it easier for developers to understand and use the Web Crypto API.

Fixes mdn#40
@0xsatoshi99 0xsatoshi99 requested a review from a team as a code owner October 31, 2025 03:30
@0xsatoshi99 0xsatoshi99 requested a review from pransh15 October 31, 2025 03:30
Copy link

@pransh15 pransh15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks @0xsatoshi99. 🙌

@pransh15 pransh15 merged commit 9540d74 into mdn:main Oct 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Web Crypto] Add links to functions.

2 participants