Generate docs with TBDocs

[leordev]

@frankhinek please let me know if you are happy with this @web5/api docs generation automation.

Preview image:

Artifact to be downloaded and tested locally: https://github.com/TBD54566975/web5-js/actions/runs/7215382638

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[codecov]

Codecov Report

Merging #352 (fc383de) into main (dbe2708) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #352   +/-   ##
=======================================
  Coverage   91.69%   91.69%           
=======================================
  Files          67       67           
  Lines       18176    18176           
  Branches     1534     1534           
=======================================
  Hits        16667    16667           
  Misses       1487     1487           
  Partials       22       22           

Components	Coverage Δ
agent	88.08% <ø> (ø)
api	96.93% <ø> (ø)
common	98.57% <ø> (ø)
credentials	∅ <ø> (∅)
crypto	94.54% <ø> (ø)
dids	92.24% <ø> (ø)
identity-agent	56.81% <ø> (ø)
crypto-aws-kms	100.00% <ø> (ø)
proxy-agent	58.43% <ø> (ø)
user-agent	55.22% <ø> (ø)

[leordev]

automatic docs publishing when a new release is cut

[github-actions]

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 340

@web5/api

• Project entry file: packages/api/src/index.ts

@web5/crypto

• Project entry file: packages/crypto/src/index.ts

📄 File: packages/crypto/src/algorithms/aes-ctr.ts
⚠️ extractor:ae-missing-release-tag: "AesCtrGenerateKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L13
⚠️ extractor:ae-missing-release-tag: "AesCtrParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L27
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L38
⚠️ docs:tsdoc-inline-tag-missing-braces: The TSDoc tag "@link" is an inline tag; it must be enclosed in "{ }" braces #L38
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L38
⚠️ extractor:ae-missing-release-tag: "AesCtrAlgorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L44

📄 File: packages/crypto/src/algorithms/aes-gcm.ts
⚠️ extractor:ae-missing-release-tag: "AesGcmGenerateKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L13
⚠️ extractor:ae-missing-release-tag: "AesGcmParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L27
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L61
⚠️ docs:tsdoc-inline-tag-missing-braces: The TSDoc tag "@link" is an inline tag; it must be enclosed in "{ }" braces #L61
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L61
⚠️ extractor:ae-missing-release-tag: "AesGcmAlgorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L67

📄 File: packages/crypto/src/algorithms/crypto-algorithm.ts
⚠️ extractor:ae-missing-release-tag: "CryptoAlgorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L4

📄 File: packages/crypto/src/algorithms/ecdsa.ts
⚠️ extractor:ae-missing-release-tag: "EcdsaGenerateKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L14
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L25
⚠️ docs:tsdoc-inline-tag-missing-braces: The TSDoc tag "@link" is an inline tag; it must be enclosed in "{ }" braces #L25
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L25
⚠️ extractor:ae-missing-release-tag: "EcdsaAlgorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L32
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L52
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L85
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L124
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L170
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L171
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L215
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L216
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L217

📄 File: packages/crypto/src/algorithms/eddsa.ts
⚠️ extractor:ae-missing-release-tag: "EdDsaGenerateKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L20
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L31
⚠️ docs:tsdoc-inline-tag-missing-braces: The TSDoc tag "@link" is an inline tag; it must be enclosed in "{ }" braces #L31
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L31
⚠️ extractor:ae-missing-release-tag: "EdDsaAlgorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L38
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L58
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L91
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L130
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L176
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L177
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L221
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L222
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L223

📄 File: packages/crypto/src/algorithms/sha-2.ts
⚠️ extractor:ae-missing-release-tag: "Sha2DigestParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L11
⚠️ extractor:ae-missing-release-tag: "Sha2Algorithm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L27
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L50
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L51

📄 File: packages/crypto/src/jose.ts
⚠️ extractor:ae-missing-release-tag: "Jose" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L62
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L73
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L127
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L180
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L181

📄 File: packages/crypto/src/jose/jwe.ts
⚠️ extractor:ae-missing-release-tag: "JweHeaderParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L3
⚠️ extractor:ae-undocumented: Missing documentation for "JweHeaderParams". #L3
⚠️ extractor:ae-undocumented: Missing documentation for "apu". #L53
⚠️ extractor:ae-undocumented: Missing documentation for "apv". #L55
⚠️ extractor:ae-undocumented: Missing documentation for "epk". #L101
⚠️ extractor:ae-undocumented: Missing documentation for "iv". #L103
⚠️ extractor:ae-undocumented: Missing documentation for "p2c". #L105
⚠️ extractor:ae-undocumented: Missing documentation for "p2s". #L107

📄 File: packages/crypto/src/jose/jwk.ts
⚠️ extractor:ae-missing-release-tag: "KEY_URI_PREFIX_JWK" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L18
⚠️ extractor:ae-missing-release-tag: "JwkOperation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L50
⚠️ extractor:ae-missing-release-tag: "JwkUse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L80
⚠️ extractor:ae-missing-release-tag: "JwkType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L85
⚠️ extractor:ae-missing-release-tag: "JwkNamedCurves" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L114
⚠️ extractor:ae-missing-release-tag: "JwkParamsAnyKeyType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L137
⚠️ extractor:ae-missing-release-tag: "JwkParamsEcPublic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L161
⚠️ extractor:ae-missing-release-tag: "JwkParamsEcPrivate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L200
⚠️ extractor:ae-missing-release-tag: "JwkParamsOkpPublic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L211
⚠️ extractor:ae-missing-release-tag: "JwkParamsOkpPrivate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L235
⚠️ extractor:ae-missing-release-tag: "JwkParamsOctPrivate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L246
⚠️ extractor:ae-missing-release-tag: "JwkParamsRsaPublic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L294
⚠️ extractor:ae-missing-release-tag: "JwkParamsRsaPrivate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L309
⚠️ extractor:ae-missing-release-tag: "PublicKeyJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L331
⚠️ extractor:ae-missing-release-tag: "PrivateKeyJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L334
⚠️ extractor:ae-missing-release-tag: "JwkKeyPair" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L337
⚠️ extractor:ae-missing-release-tag: "Jwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L346
⚠️ extractor:ae-missing-release-tag: "computeJwkThumbprint" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L393
⚠️ extractor:ae-missing-release-tag: "isEcPrivateJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L436
⚠️ extractor:ae-missing-release-tag: "isEcPublicJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L451
⚠️ extractor:ae-missing-release-tag: "isOctPrivateJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L466
⚠️ extractor:ae-missing-release-tag: "isOkpPrivateJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L480
⚠️ extractor:ae-missing-release-tag: "isOkpPublicJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L495
⚠️ extractor:ae-missing-release-tag: "isPrivateJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L510
⚠️ extractor:ae-missing-release-tag: "isPublicJwk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L533

📄 File: packages/crypto/src/jose/jws.ts
⚠️ extractor:ae-missing-release-tag: "JoseHeaderParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L3
⚠️ extractor:ae-undocumented: Missing documentation for "JoseHeaderParams". #L3
⚠️ extractor:ae-missing-release-tag: "JwsHeaderParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L29
⚠️ extractor:ae-undocumented: Missing documentation for "JwsHeaderParams". #L29

📄 File: packages/crypto/src/jose/jwt.ts
⚠️ extractor:ae-missing-release-tag: "JwtHeaderParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L34
⚠️ extractor:ae-missing-release-tag: "JwtPayload" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L68

📄 File: packages/crypto/src/jose/utils.ts
⚠️ extractor:ae-missing-release-tag: "canonicalize" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L11

📄 File: packages/crypto/src/local-kms-crypto.ts
⚠️ extractor:ae-missing-release-tag: "LocalKmsCryptoParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L69
⚠️ extractor:ae-missing-release-tag: "LocalKmsDigestParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L83
⚠️ extractor:ae-missing-release-tag: "LocalKmsGenerateKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L96
⚠️ extractor:ae-missing-release-tag: "LocalKmsCrypto" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L105
⚠️ extractor:ae-undocumented: Missing documentation for "LocalKmsCrypto". #L105
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L151
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L152
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L183
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L208
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L257
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L285
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L327
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L369
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L370
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L411
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L412
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L413
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L446
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L485
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L518

📄 File: packages/crypto/src/primitives/aes-ctr.ts
⚠️ docs:tsdoc-escape-greater-than: The ">" character should be escaped using a backslash to avoid confusion with an HTML tag #L29
⚠️ docs:tsdoc-escape-greater-than: The ">" character should be escaped using a backslash to avoid confusion with an HTML tag #L30
⚠️ extractor:ae-missing-release-tag: "AES_KEY_LENGTHS" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L37
⚠️ extractor:ae-missing-release-tag: "AesCtr" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L98
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L120
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L162
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L163
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L164
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L165
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L227
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L228
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L229
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L230
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L291
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L335

📄 File: packages/crypto/src/primitives/aes-gcm.ts
⚠️ docs:tsdoc-escape-greater-than: The ">" character should be escaped using a backslash to avoid confusion with an HTML tag #L28
⚠️ docs:tsdoc-escape-greater-than: The ">" character should be escaped using a backslash to avoid confusion with an HTML tag #L29
⚠️ extractor:ae-missing-release-tag: "AES_KEY_LENGTHS" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L36
⚠️ docs:tsdoc-escape-greater-than: The ">" character should be escaped using a backslash to avoid confusion with an HTML tag #L43
⚠️ extractor:ae-missing-release-tag: "AES_GCM_TAG_LENGTHS" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L53
⚠️ extractor:ae-missing-release-tag: "AesGcm" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L101
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L123
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L169
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L170
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L171
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L172
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L173
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L241
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L242
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L243
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L244
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L245
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L308
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L353

📄 File: packages/crypto/src/primitives/concat-kdf.ts
⚠️ extractor:ae-missing-release-tag: "ConcatKdfOtherInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L5
⚠️ extractor:ae-undocumented: Missing documentation for "ConcatKdfOtherInfo". #L5
⚠️ extractor:ae-missing-release-tag: "ConcatKdf" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L87
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L107
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L108
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L109
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L112
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L112
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L193
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L194
⚠️ docs:tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag #L198
⚠️ docs:tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@" #L198

📄 File: packages/crypto/src/primitives/ed25519.ts
⚠️ extractor:ae-missing-release-tag: "Ed25519" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L58
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L81
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L125
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L162
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L206
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L254
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L345
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L383
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L416
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L453
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L454
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L490
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L531
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L532
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L533

📄 File: packages/crypto/src/primitives/pbkdf2.ts
⚠️ extractor:ae-missing-release-tag: "Pbkdf2DeriveKeyParams" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L6
⚠️ extractor:ae-missing-release-tag: "Pbkdf2" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L68
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L91
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L92
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L93
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L94
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L95

📄 File: packages/crypto/src/primitives/secp256k1.ts
⚠️ extractor:ae-missing-release-tag: "Secp256k1" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L70
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L98
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L149
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L191
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L227
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L273
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L309
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L386
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L426
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L465
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L521
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L522
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L573
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L574
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L617
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L648
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L701
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L702
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L703
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L751

📄 File: packages/crypto/src/primitives/sha256.ts
⚠️ docs:tsdoc-at-sign-in-word: The "@" character looks like part of a TSDoc tag; use a backslash to escape it #L6
⚠️ extractor:ae-missing-release-tag: "Sha256" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L20
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L36

📄 File: packages/crypto/src/primitives/x25519.ts
⚠️ extractor:ae-missing-release-tag: "X25519" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L48
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L74
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L122
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L163
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L250
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L292
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L329
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L380
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L381

📄 File: packages/crypto/src/primitives/xchacha20-poly1305.ts
⚠️ extractor:ae-missing-release-tag: "XChaCha20Poly1305" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) #L69
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters #L90
⚠️ docs:tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name: The identifier cannot non-word characters [#L135](https://github.com/TBD54566975/web5-js/blob/3b4685b2b226949b9ecad2d6d1cb411cb05588c5/packag...*[Comment body truncated]*

[angiejones]

what do you all think about including all of the web5 packages here, namely dids, credentials, and crypto? Or should they have their own docs?

[leordev]

what do you all think about including all of the web5 packages here, namely dids, credentials, and crypto? Or should they have their own docs?

We are planning exactly on that, but first we need to fix the doc errors!

[leordev]

Closing in favor of #402