Exergie/dynalab-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added guarantee warnings on documenation and fix typos

Browse Source
This commit is contained in:
h3cx
2026-08-08 22:25:17 +01:00
parent f519238944
commit ce4261cb60
3 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+4
View File
@@ -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.
docs/Protocol.md
+4 -1
View File
@@ -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
docs/README.md
+3
View File
@@ -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