Two.js: Update Documentation for Two.js

[jonobr1]

This is a multipart issue:

1. Update documentation based on jsdocs formatting
2. Render documentation with jsdoc-to-markdown
3. Style documentation based on https://two.js.org/ and include with dev repository for local development

[jonobr1]

Have currently added documentation to all "top level" src files. Now need to go through src/effects, src/renderer, and src/shapes and add documentation there to complete step one.

[eulertour]

Have currently added documentation to all "top level" src files. Now need to go through src/effects, src/renderer, and src/shapes and add documentation there to complete step one.

Is this true? Looking at the documentation at https://two.js.org/#documentation, it seems that documentation for Two.Matrix, Two.Registry and Two.Shape are missing.

[jonobr1]

@eulertour, the most up-to-date documentation lives in the source files now. This documentation has yet to be generated because I'm still writing it for each class, property, function, etc. Inline above each property there is a jsdoc style comment that describes what it does or expects.

I still have the effects folder and the renderers folder to do before I tackle rendering the documentation into HTML.

[meetzaveri]

Hey Jono,

Just wanted to let you know that some of the new APIs(such as two.makeArrow) are not part of the documentation.

Is documentation moved away or it isn't updated acc. to latest stable release of 0.7.0?

[jonobr1]

Thanks for your post @meetzaveri, if you read the thread you'll see that the documentation has been moved to the source code as jsdocs style comments. This issue is to track generating and styling the new documentation for the site.

If you'd like to see what exists so far you can pull the latest dev repository, npm install, run npm run docs:generate, and finally npm run docs:dev.

[meetzaveri]

Got it. This clears out my confusion.

[jonobr1]

New designs for the Two.js site and documentation by the amazing @yuinchien:

Here's the figma file.

[meetzaveri]

New design looks dope

[meetzaveri]

I think with this new design, API docs looks more accurate than before.

Any idea when will be new design pushed?

[jonobr1]

No clear timeline on when this will all be implemented. But, slowly making progress!

Thanks for your patience.