Documentation Structure

The DeepLynx wiki is separated into four major parts. This is done so that you as a user can more quickly find the information that is most relevant to you. If you feel like the organization is convoluted however, please reach out to the team so that we can correct the issue.

Here are each of the four sections, followed by a brief description.

Building DeepLynx

This section describes the steps needed to deploy a local instance of DeepLynx.

Integrating With DeepLynx

This section is for those who wish to build integrations with DeepLynx. These integrations typically include data sources, UI's, and reacting to published events from DeepLynx. This is another technically heavy piece of documentation and is generally meant for those building software which communicate or integrate with DeepLynx directly.

Using DeepLynx

This section is for anyone wishing to interact with DeepLynx, whether it be through the official web app or the HTTP server directly. While there are some technical sections, this section is targeted to a more general audience and the end user of the official web app.

Developing DeepLynx

This section is targeted towards those who wish to modify or add to DeepLynx itself. This is a technical advice and knowledge heavy section of the documentation and is meant for software developers and engineers. This section also describes the structure of DeepLynx's code base, design decisions, and serves as an excellent starting point for any new DeepLynx developer.