pencil-js/pencil.js

Document Scene's first parameter: parent

ecstrema opened this issue · 3 comments

Hello there,
This is not code related (even if at the end it falls to that).

When looking at the library, I had a hard time understanding how to use the Scene element without having my whole webpage as a canvas. When I looked at the website code, it only showed how to use the div's data-script attribute, which is not convenient for many use cases.

I finally found out that the answer was to use the scene first parameter, which is not described anywhere in the docs, except in this code example. The example gives no info about it.

This of course relates to #28: find a good docs generator.

Thanks for the report.
Indeed documentation is not the best right now. You can find some informations on the Guide's Scene section.
But, sure thing to do is resolve #28 and auto-generate a thorough documentation.

I'm still working on it, but you should find everything you need in the documentation.

Looks good! Thanks!