jeromeetienne / ar.js-docs

documentation for AR.js

• Read Me
• CHANGELOG
• EXAMPLES
• FAQ
• FUTURE

Posts

• post-XX-how-to-use-arjs-with-aframe

ar.js-docs's Issues

None of the examples are available

They all send us to a dead link.

Fixing AR-docs GitHub Page hosting

@jeromeetienne I mentioned to you this on gitter, that this repository is not accessible as a GitHub page.
I forked this repository to figure out why this is not working, thankfully i managed to fix it in my forked repo, you can check it out here https://zoltanveres.github.io/AR.js-docs/docs/index.html
.

I wanted to creat a pull request upon your suggestion, but this cannot be fixed with that.
So here are steps which helped fix this:

1. Enable github pages for the site on Settings -> Github Pages section and choose master branch (see attached image):
   

2. Replace the description url from https://jeromeetienne.github.io/ar.js-docs/ to https://jeromeetienne.github.io/AR.js-docs/docs/index.html

I know this is sort of a half-measure solution, but it gets the job done. Let me know what you think.

Examples broken

Many of the links on the examples page result in a 404. Cloning the repo and trying examples locally is not a good replacement option since their dependencies are not in the repo.

https://jeromeetienne.github.io/AR.js-docs/misc/EXAMPLES.html

Generation of jsdoc documentation

• take ar.js source from the repository - https://github.com/jeromeetienne/ar.js
  • include it as git submodules
• change the Makefile to launch jsdoc generation make jsdoc
• output the result into a folder /jsdoc