Help us develop the next-generation software, now in alpha!

Improve documentation of socket API

The socket API is not easily discoverable (no hints from Logic itself on how to use it, and as far as I know the documentation exists only within a markdown file in a folder in a GitHub repo for a C# client), and the existing documentation is tightly coupled to the C# client.

Suggested actions:

  • Separate the documentation of the API itself and the C# client.
  • Host the documentation on saleae.com, or on readthedocs.io.
  • Separate the high-level explanation from the low-level instructions on how to use each command.
  • Add example code for minimal working examples in some languages (Python, Javascript, Java, C++). I'm sure external contributors who are familiar with the different languages will be happy to provide this if the API documentation is good.
  • Jonathan Gjertsen
  • Mar 22 2019
  • Needs review