simple-keyboard/simple-keyboard-layouts

documentation about layout - (keyboard only)

c0ncentus opened this issue · 1 comments

Is your feature request related to a problem? Please describe.
i search deep into the doc but not solve a real basic issue, I feel kind a stupid.

Describe the solution you'd like
Make a TRUE "get started" writting about parameters and type ...
it's take one paragraph not such hard work !

The rest of the doc is really good but research is like hell because open ~10 links and dont really have the behaviour specially desired.

Describe alternatives you've considered
either make it more exhaustive about layout page (all possibilities), either make an exemple with only keyboard because it is a large use case ... https://codesandbox.io/s/n5mllkkmyl?file=/src/index.js:2207-2291.
THAT link it is a good layout exemple (I think) !

Additional context
I'm new to the library and it's like very hight quality stuff !

Hey @c0ncentus, the main repo for simple-keyboard is here: https://github.com/hodgef/simple-keyboard

I had made some adjustments so people can find the info quicker. For example, by bringing the "layout" docs to the top:
image
https://hodgef.com/simple-keyboard/documentation/options/layout/

And by having a questions and answers section to address common use cases:

image
https://hodgef.com/simple-keyboard/questions-answers/

If you mean that this repo (the layouts repo) is hard to follow, I'm not super sure since the docs linked in the Readme is pretty straightforward: https://hodgef.com/simple-keyboard/modules/simple-keyboard-layouts/

I understand what you mean about having all params in one page though, I will try to see how I can improve that in a future docs update. Thanks!

Note: I'll lock the thread since I think this was better suited for the main repo. If you have issues with the simple-keyboard library please file them here: https://github.com/hodgef/simple-keyboard