docs: update typedoc config (#3146)

- Use only `@packageDocumentation` for each module's landing page
- Do not duplicate headers
- Use monorepo readme for home page

Author: achingbrain

doc/package.json

@@ -17,7 +17,7 @@
     "doc-check": "aegir doc-check"
   },
   "devDependencies": {
-    "aegir": "^47.0.6"
+    "aegir": "^47.0.14"
   },
   "private": true
 }

interop/package.json

@@ -14,19 +14,19 @@
     "@chainsafe/libp2p-noise": "^16.1.3",
     "@chainsafe/libp2p-quic": "^1.1.1",
     "@chainsafe/libp2p-yamux": "^7.0.1",
-    "@libp2p/circuit-relay-v2": "^3.2.12",
-    "@libp2p/identify": "^3.0.30",
-    "@libp2p/interface": "^2.10.0",
-    "@libp2p/mplex": "^11.0.36",
-    "@libp2p/ping": "^2.0.30",
-    "@libp2p/tcp": "^10.1.11",
-    "@libp2p/tls": "^2.2.1",
-    "@libp2p/webrtc": "^5.2.13",
-    "@libp2p/websockets": "^9.2.11",
-    "@libp2p/webtransport": "^5.0.41",
+    "@libp2p/circuit-relay-v2": "^3.2.14",
+    "@libp2p/identify": "^3.0.32",
+    "@libp2p/interface": "^2.10.2",
+    "@libp2p/mplex": "^11.0.38",
+    "@libp2p/ping": "^2.0.32",
+    "@libp2p/tcp": "^10.1.13",
+    "@libp2p/tls": "^2.2.3",
+    "@libp2p/webrtc": "^5.2.15",
+    "@libp2p/websockets": "^9.2.13",
+    "@libp2p/webtransport": "^5.0.43",
     "@multiformats/multiaddr": "^12.4.0",
-    "aegir": "^47.0.6",
-    "libp2p": "^2.8.6",
+    "aegir": "^47.0.14",
+    "libp2p": "^2.8.8",
     "p-event": "^6.0.1",
     "redis": "^4.7.1"
   }

packages/config/package.json

@@ -46,7 +46,7 @@
     "interface-datastore": "^8.3.1"
   },
   "devDependencies": {
-    "aegir": "^47.0.6",
+    "aegir": "^47.0.14",
     "datastore-core": "^10.0.2"
   },
   "sideEffects": false

packages/config/typedoc.json

@@ -1,4 +1,5 @@
 {
+  "readme": "none",
   "entryPoints": [
     "./src/index.ts"
   ]

packages/connection-encrypter-plaintext/package.json

@@ -57,9 +57,9 @@
   "devDependencies": {
     "@libp2p/crypto": "^5.1.4",
     "@libp2p/logger": "^5.1.18",
-    "aegir": "^47.0.6",
+    "aegir": "^47.0.14",
     "it-pair": "^2.0.6",
-    "protons": "^7.6.0",
+    "protons": "^7.6.1",
     "sinon": "^20.0.0"
   },
   "sideEffects": false

packages/connection-encrypter-plaintext/typedoc.json

@@ -1,4 +1,5 @@
 {
+  "readme": "none",
   "entryPoints": [
     "./src/index.ts"
   ]

packages/connection-encrypter-tls/package.json

@@ -57,9 +57,9 @@
   },
   "devDependencies": {
     "@libp2p/logger": "^5.1.18",
-    "aegir": "^47.0.6",
+    "aegir": "^47.0.14",
     "it-pair": "^2.0.6",
-    "protons": "^7.6.0",
+    "protons": "^7.6.1",
     "sinon": "^20.0.0",
     "sinon-ts": "^2.0.0"
   },

packages/connection-encrypter-tls/typedoc.json

@@ -1,4 +1,5 @@
 {
+  "readme": "none",
   "entryPoints": [
     "./src/index.ts"
   ]

packages/crypto/README.md

@@ -26,7 +26,7 @@ repo and examine the changes made.
 
 The `libp2p-crypto` library depends on the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) in the browser. Web Crypto is available in all modern browsers, however browsers restrict its usage to [Secure Contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
 
-*This means you will not be able to use some `@libp2p/crypto` functions in the browser when the page is served over HTTP.*
+This means you will not be able to use some `@libp2p/crypto` functions in the browser when the page is served over HTTP.\*
 
 To enable the Web Crypto API and allow `@libp2p/crypto` to work fully, please serve your page over HTTPS.
 

packages/crypto/package.json

@@ -88,17 +88,17 @@
     "@libp2p/interface": "^2.10.2",
     "@noble/curves": "^1.9.1",
     "@noble/hashes": "^1.8.0",
-    "multiformats": "^13.3.4",
+    "multiformats": "^13.3.6",
     "protons-runtime": "^5.5.0",
     "uint8arraylist": "^2.4.8",
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.10",
-    "aegir": "^47.0.6",
+    "aegir": "^47.0.14",
     "asn1js": "^3.0.6",
     "benchmark": "^2.1.4",
-    "protons": "^7.6.0"
+    "protons": "^7.6.1"
   },
   "browser": {
     "./dist/src/ciphers/aes-gcm.js": "./dist/src/ciphers/aes-gcm.browser.js",