16 lines
816 B
Markdown
16 lines
816 B
Markdown
# 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
|
|
- Internal
|
|
|
|
[**API**](API.md) - Documents the user side API of the `Core` class, this goes through setting up a new core, and how to interact with it
|
|
|
|
[**Protocol**](Protocol.md) - Documents the data ingress protocol, this is useful for developing connectors to pipe data into the DynaLab Core
|
|
|
|
[**Internal**](Internal/README.md) - Documents the inner working of DynaLab Core including data flow, internal API's, custom file types and much more
|