You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Documentation on http://www.nodegit.org/ out of date #196
The two examples on the homepage of the site, 'emulate git log' and 'view commit tree and blob information' don't work, whereas the examples in the readme do.
Also, for lack of knowledge with the codebase and API, I'm not sure if the information on the right sidebar of the site, or the doc on http://www.nodegit.org/nodegit/ is up to date or not, either
Theme and mobile friendliness are the smallest of issues. Auto generating API docs sounds far more important. The final API document can be even just a markdown file but its contents should be up to date so you don't have to dig up the source codes for usage examples.
Agreed 100% @kimmobrunfeldt. We have a designer though who is working on those pieces that engineers needn't worry about. I've been focusing on getting the API loaded and docs filled out, but it's going slowly due to work. You can follow progress along in the nodegit.github.com repository.
Activity
tbranyen commentedon Jul 12, 2014
Duplicate of: #190
This is a known issue and we're working on it, if you'd like to help out: https://github.com/nodegit/nodegit.github.com
We're trying to lock down:
At the moment there is a demo spot for the Emscripten build, but I don't want to think about that until the rest of the library feels solid.
kimmobrunfeldt commentedon Jul 28, 2014
Theme and mobile friendliness are the smallest of issues. Auto generating API docs sounds far more important. The final API document can be even just a markdown file but its contents should be up to date so you don't have to dig up the source codes for usage examples.
tbranyen commentedon Jul 28, 2014
Agreed 100% @kimmobrunfeldt. We have a designer though who is working on those pieces that engineers needn't worry about. I've been focusing on getting the API loaded and docs filled out, but it's going slowly due to work. You can follow progress along in the nodegit.github.com repository.