Better documentation about node-neo4j

[gasi]

Agreed, but we’ve been busy using the library on www.thethingdom.com and hence are quite confident in its functionality. Would you like to help us in a documentation effort?

/cc @aseemk

[anatoliychakkaev]

Yep, sure, I going to write tutorial and can improve readme file with usage examples. I hope I'll get a chance to do it at this weekend.

[funkotron]

Thanks for the offer @anatoliychakkaev

This would be very helpful.

[ivolo]

Looking forward to documentation!

[thomasfr]

Me too.

[aseemk]

We still don't have proper API docs (TODO: we could/should use docco for that?), but in the meantime, I've took a stab at improving our readme documentation and examples:

https://github.com/thingdom/node-neo4j#readme

What do you guys think?

[aseemk]

FYI, for anyone running into this now -- I built a sample app a while back that shows usage of this library pretty comprehensively (at least the way we use it):

https://github.com/aseemk/node-neo4j-template

Over this next week or two, I'm hoping to improve the documentation of this library a bit, but consider this sample code for now!

[anatoliychakkaev]

heck this:
https://github.com/1602/jugglingdb/blob/master/lib/adapters/neo4j.js

It's an adapter for jugglingdb, one very basic operations used: create,
update, delete, index, cypherQuery.

Hope it helps.

On Fri, Apr 13, 2012 at 7:02 PM, Aseem Kishore <
[email protected]

wrote:

FYI, for anyone running into this now -- I built a sample app a while back
that shows usage of this library pretty comprehensively (at least the way
we use it):

https://github.com/aseemk/node-neo4j-template

Over this next week or two, I'm hoping to improve the documentation of
this library a bit, but consider this sample code for now!

---

Reply to this email directly or view it on GitHub:
#6 (comment)

Cheers,
Anatoliy Chakkaev
web-developer [js, rails, php]
+7.917.857.858.4

[aseemk]

Cool stuff! Thanks @anatoliychakkaev.

[aseemk]

Although, it worries me that jugglingdb's package.json specifies all dependencies as e.g. >= 0.2.5.

I definitely foresee us introducing breaking changes to the API as we clean it up in the future (and adapt it to Neo4j changes); it'd be a shame to see adapters like this break.

If you know the jugglingdb guys, mind suggesting them to change their dependencies to e.g. ~0.2.5 instead? (That's equivalent to >= 0.2.5 < 0.3.)

[aseemk]

(Oops, just realized the author of jugglingdb was the one that opened this issue! =P)

Could this issue be prioritized.

It feels that this library is the only good one for neo4j.

I would gladly help out if you could just tell me how.

[aseemk]

You're definitely right, it should be. Sorry that I haven't found the time to do so!

If you could indeed help, that would be super appreciated. I had come across Codo and it looked like it might be a great fit for our API documentation.

What do you think?

I just moved over to LiveScript some days ago :/. I thought I could contribute since I was using CoffeeScript as well a week ago.

However, that library seems really solid!

[aseemk]

Psst, this is finally in progress!

Source:
https://github.com/thingdom/node-neo4j/compare/feature/documentation

Generated documentation:
https://dl.dropbox.com/u/25149872/node-neo4j/doc/index.html

Codo issues getting worked out:
coffeedoc/codo#64

=)

[aseemk]

After many, many months, this library finally has proper API documentation!

http://coffeedoc.info/github/thingdom/node-neo4j/master/

Suh-weet! Full code diff if anyone's interested in seeing how nice Codo is:

dc8077c^...dc8077c

Enjoy! And let me know if you'd like to see anything else documented.

[gasi]

Nice work, @aseemk, the docs are gorgeous.