Made suggested changes.

Signed-off-by: Cody Littley <cody@eigenlabs.org>
Layr-Labs · Oct 18, 2024 · 17c9f4b · 17c9f4b
1 parent 35d9400
commit 17c9f4b
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 57 deletions.
diff --git a/api/proto/README.md b/api/proto/README.md
@@ -1,12 +1,41 @@
-# Should I use the v2 API?
+# A note about experimental/WIP APIs
 
-No. The v2 API is currently under active development, and is not yet deployed to any environment.
+There are a number of APIs that are currently under active development. These APIs can be fully ignored.
+All such APIs will have comments in the form
 
-# Is the v2 API stable?
+```
+/////////////////////////////////////////////////////////////////////////////////////
+// Experimental: the following definitions are experimental and subject to change. //
+/////////////////////////////////////////////////////////////////////////////////////
+```
 
-No, although it is becoming more stable as the v2 design matures.
+The majority of the WIP APIs are for a project we are calling internally `EigenDA v2 Architecture`.
+More on that below.
 
-# What is "v2"?
+## Q: Which APIs are currently experimental?
+
+The following APIs are currently experimental:
+- `disperser/v2/*`
+- `lightnode/*`
+- `node/v2/*`
+- `relay/*`
+
+## Q: are APIs not marked with "Experimental" stable?
+
+Yes. We are commited to maintaining backwards compatibility for all APIs that are not marked as experimental,
+and any breaking changes will be made only after a long deprecation period and active communication with
+all stakeholders. Furthermore, breaking API changes are expected to be rare.
+
+## Q: Should I use experimental APIs?
+
+No. No experimental APIs are currently deployed to any public environments. In general, assume
+that experimental APIs are not functional absent messaging from the EigenDA team declaring otherwise.
+
+## Q: Are experimental APIs stable?
+
+No, although they will become more and more stable as they reach maturity.
+
+## Q: What is "v2"?
 
 The EigenDA v2 Architecture is a fundamental redesign of the protocol. The v2 Architecture improves robustness,
 efficiency, and paves the way for upcoming features such as permissionless disperser instances

diff --git a/api/proto/disperser/v2/README.md b/api/proto/disperser/v2/README.md
diff --git a/api/proto/lightnode/README.md b/api/proto/lightnode/README.md
diff --git a/api/proto/node/v2/README.md b/api/proto/node/v2/README.md
diff --git a/api/proto/relay/README.md b/api/proto/relay/README.md