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

Documentation website #12

Closed
andrezero opened this issue Apr 2, 2020 · 3 comments · Fixed by #54
Closed

Documentation website #12

andrezero opened this issue Apr 2, 2020 · 3 comments · Fixed by #54
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@andrezero
Copy link

Hey all!

Arriving from schteppe#438 and very happy to see a fork actively maintanted.

The README here still says "Visit the original project for full documentation and examples." but the reality is the original project is "[...] slowly disintegrating. Piece by piece." :-D

I see everything is typescripted now, so there must be some good tools out there now, better than YUI for sure!

How can we help get this documentation website up?

@codynova
Copy link
Member

codynova commented Apr 2, 2020

Hi @andrezero, good timing - new documentation using the Typedoc generator and TSDoc parser are a work in progress as of today

@codynova codynova added the documentation Improvements or additions to documentation label Apr 2, 2020
@codynova
Copy link
Member

codynova commented Apr 2, 2020

For anyone discovering this issue from the original cannon.js repo, you can still find perfectly working documentation here:

http://schteppe.github.io/cannon.js/docs/

@andrezero
Copy link
Author

For anyone discovering this issue from the original cannon.js repo, you can still find perfectly working documentation here:

http://schteppe.github.io/cannon.js/docs/

for anyone following that link, heads up: note the http:// ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants