ci: check doc diff (#3417)

* ci: check unstaged after docs

* docs: update generated docs

Author: tabcat

.github/workflows/main.yml

@@ -40,6 +40,7 @@ jobs:
       - run: npm run --if-present lint
       - run: npm run --if-present dep-check
       - run: npm run --if-present docs:no-publish
+      - run: git diff --exit-code
       - run: npm run --if-present doc-check
       - run: npm run --if-present spell-check
 

packages/keychain/README.md

@@ -45,7 +45,7 @@ The key management and naming service API all return a `KeyInfo` object.  The `i
 
 The **key id** is the SHA-256 [multihash](https://github.com/multiformats/multihash) of its public key.
 
-The *public key* is a [protobuf encoding](https://github.com/libp2p/js-libp2p/blob/958761163edfc7b1a6231041b199737d72fd6424/packages/crypto/src/keys/keys.proto) containing a type and the [DER encoding](https://en.wikipedia.org/wiki/X.690) of the PKCS [SubjectPublicKeyInfo](https://www.ietf.org/rfc/rfc3279.txt).
+The *public key* is a [protobuf encoding](https://github.com/libp2p/js-libp2p/blob/main/packages/crypto/src/keys/keys.proto) containing a type and the [DER encoding](https://en.wikipedia.org/wiki/X.690) of the PKCS [SubjectPublicKeyInfo](https://www.ietf.org/rfc/rfc3279.txt).
 
 ## Private key storage
 
@@ -55,7 +55,7 @@ The default options for generating the derived encryption key are in the `dek` o
 
 ```TypeScript
 const defaultOptions = {
-  // See https://cryptosense.com/parameter-choice-for-pbkdf2/
+  // See https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2
   dek: {
     keyLength: 512 / 8,
     iterationCount: 1000,

packages/libp2p/README.md

@@ -24,7 +24,7 @@ repo and examine the changes made.
 
 -->
 
-The AutoNAT service implements the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
+The AutoNAT service implements the [AutoNAT protocol](https://libp2p.io/docs/autonat/)
 to confirm whether addresses the node is listening on are dialable by remote
 peers.
 

packages/protocol-autonat/README.md

@@ -24,7 +24,7 @@ repo and examine the changes made.
 
 -->
 
-The `circuitRelayTransport` allows libp2p to dial and listen on [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+The `circuitRelayTransport` allows libp2p to dial and listen on [Circuit Relay](https://libp2p.io/docs/circuit-relay/)
 addresses.
 
 ## Example - Use as a transport
@@ -42,7 +42,7 @@ const node = await createLibp2p({
 })
 ```
 
-The `circuitRelayServer` function allows libp2p to function as a [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+The `circuitRelayServer` function allows libp2p to function as a [Circuit Relay](https://libp2p.io/docs/circuit-relay/)
 server.  This will not work in browsers.
 
 ## Example - Use as a server

packages/transport-circuit-relay-v2/README.md

@@ -36,7 +36,7 @@ The connection establishment phase of WebRTC involves a handshake using [SDP](ht
 
 A third party is usually necessary to carry out this handshake, forwarding messages between the two peers until they can make a direct connection between themselves.
 
-The WebRTC transport uses libp2p [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)s to forward SDP messages. Once a direct connection is formed the relay plays no further part in the exchange.
+The WebRTC transport uses libp2p [Circuit Relay](https://libp2p.io/docs/circuit-relay/)s to forward SDP messages. Once a direct connection is formed the relay plays no further part in the exchange.
 
 WebRTC Direct uses a technique known as [SDP munging](https://webrtchacks.com/not-a-guide-to-sdp-munging/) to skip the handshake step, instead encoding enough information in the connection request that the responder can derive what would have been in the handshake messages and so requires no third parties to establish a connection.
 

packages/transport-webrtc/README.md

@@ -24,22 +24,7 @@ repo and examine the changes made.
 
 -->
 
-The libp2p ecosystem has lots of repos with it comes several problems like:
-
-- Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
-- Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.
-
-These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having `libp2p-utils` updated.
-
-## Example
-
-Each function should be imported directly.
-
-```TypeScript
-import { ipPortToMultiaddr } from '@libp2p/utils'
-
-const ma = ipPortToMultiaddr('127.0.0.1', 9000)
-```
+This module contains utility functions used by libp2p modules.
 
 # Install