docs: update interface-internal readme (#2972)

Update the readme with the new package documentation block.
libp2p · Feb 19, 2025 · 754fe84 · 754fe84
1 parent a2c529a
commit 754fe84
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/packages/interface-internal/README.md b/packages/interface-internal/README.md
@@ -7,6 +7,29 @@
 
 > Interfaces implemented by internal libp2p components
 
+# About
+
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+This module serves as the entry point for `@libp2p/interface-internal`,
+exporting key components such as `AddressManager`, `ConnectionManager`,
+`RandomWalk`, `Registrar`, and `TransportManager`.
+
+These interfaces and classes define the core internal behaviors of libp2p.
+
 # Install
 
 ```console

diff --git a/packages/interface-internal/src/index.ts b/packages/interface-internal/src/index.ts
@@ -2,7 +2,7 @@
  * @packageDocumentation
  *
  * This module serves as the entry point for `@libp2p/interface-internal`,
- * re-exporting key components such as `AddressManager`, `ConnectionManager`,
+ * exporting key components such as `AddressManager`, `ConnectionManager`,
  * `RandomWalk`, `Registrar`, and `TransportManager`.
  *
  * These interfaces and classes define the core internal behaviors of libp2p.