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

Improve documentation #196

Open
aitorllj93 opened this issue Dec 24, 2022 · 2 comments
Open

Improve documentation #196

aitorllj93 opened this issue Dec 24, 2022 · 2 comments

Comments

@aitorllj93
Copy link
Contributor

aitorllj93 commented Dec 24, 2022

I think this beautiful library should have a good documentation as well. Right now, many links on the readme are failing, the npm package doesn't have readme at all and you usually need to dig deep into the source code to read the examples and node descriptions in order to be able to properly work with it. I would improve the Readme and add a documentation website (thinking about docusaurus) with all the examples available. I think this would be a great improvement on the library overall.

@bhouston if you agree I can start working on it

@bhouston
Copy link
Owner

please do! Be aware that this is an implementation that is helping to drive the glTF interactivity extension: https://github.com/ux3d/glTF/blob/00606e5d654c0c319c274250f3505e70e05d6102/extensions/2.0/Khronos/KHR_behavior/README.md. You can find additional documentation there. It is sort of an eventual consistency model between this library and that extension.

@aitorllj93
Copy link
Contributor Author

aitorllj93 commented Dec 25, 2022

@bhouston working on it, hope to have an initial PR for today or tomorrow and we can discuss about some details when it's ready

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

No branches or pull requests

2 participants