Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs lack any charts, graphics or visual aids #154

Open
Arlodotexe opened this issue Jun 11, 2022 · 0 comments
Open

Docs lack any charts, graphics or visual aids #154

Arlodotexe opened this issue Jun 11, 2022 · 0 comments
Labels

Comments

@Arlodotexe
Copy link
Owner

Arlodotexe commented Jun 11, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant