diff --git a/docs/API.md b/docs/API.md index e69de29..6a71317 100644 --- a/docs/API.md +++ b/docs/API.md @@ -0,0 +1,4 @@ +# DynaLab Core API Documentation + +> [!WARNING] +> Protocol documentation is currently being written. It may contain incomplete or incorrect information. While DynaLab Core is in it's alpha stage it is the users responsibility to cross check the information provided in documentation with the codebase. diff --git a/docs/Protocol.md b/docs/Protocol.md index 6ad1899..fdd5835 100644 --- a/docs/Protocol.md +++ b/docs/Protocol.md @@ -1,4 +1,7 @@ -# DynaLab Protocol +# DynaLab Core Protocol + +> [!WARNING] +> Protocol documentation is currently being written. It may contain incomplete or incorrect information. While DynaLab Core is in it's alpha stage it is the users responsibility to cross check the information provided in documentation with the codebase. > [!NOTE] > All protocol documentation uses JSON packets as examples, however it applies to any form of communication protocol used for data ingress diff --git a/docs/README.md b/docs/README.md index c83b93d..863b22f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,8 @@ # DynaLab Core Documentation +> [!WARNING] +> Protocol documentation is currently being written. It may contain incomplete or incorrect information. While DynaLab Core is in it's alpha stage it is the users responsibility to cross check the information provided in documentation with the codebase. + This documentation is ordered in the following sections - API - Protocol