From 754fe84db8f5f075c4fb23f1c2b9539b71ab3b66 Mon Sep 17 00:00:00 2001
From: Alex Potsides <alex@achingbrain.net>
Date: Wed, 19 Feb 2025 13:33:18 +0000
Subject: [PATCH] docs: update interface-internal readme (#2972)

Update the readme with the new package documentation block.
---
 packages/interface-internal/README.md    | 23 +++++++++++++++++++++++
 packages/interface-internal/src/index.ts |  2 +-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/packages/interface-internal/README.md b/packages/interface-internal/README.md
index 0f48ed3d52..554f86ae71 100644
--- 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
index bd0aa778b6..76ae8100a9 100644
--- 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.