The Strix Music SDK, while well architectured, is no simple thing. We have several explainers for the most essential things devs should know about in our documentation.
The problem
There's plenty of code and screenshots in the docs, but no visual aids to help simplify things.
A couple of charts helping explain some of the hard parts would go a long way for new devs who are just onboarding and getting a feel for things.
The solution
In the docs, particularly in places where it gets complicated - paragraphs of text, sets of bullet points - we should create a graph explaining the relations between all the things being discussed.
The How it works section is a good example of this.
The Home page is another that could make great use of this.
Ideally, charts should be exported as SVGs and stored somewhere we can edit it, if needed.
LucidChart should be able to do one or both of these
Background
The Strix Music SDK, while well architectured, is no simple thing. We have several explainers for the most essential things devs should know about in our documentation.
The problem
There's plenty of code and screenshots in the docs, but no visual aids to help simplify things. A couple of charts helping explain some of the hard parts would go a long way for new devs who are just onboarding and getting a feel for things.
The solution
In the docs, particularly in places where it gets complicated - paragraphs of text, sets of bullet points - we should create a graph explaining the relations between all the things being discussed.
The How it works section is a good example of this. The Home page is another that could make great use of this.
Ideally, charts should be exported as SVGs and stored somewhere we can edit it, if needed.
LucidChart should be able to do one or both of these