G-Node / nix

Neuroscience information exchange format
https://readthedocs.org/projects/nixio/
Other
66 stars 36 forks source link

Adding Wiki for easy understanding of NIX project #667

Closed s0nskar closed 6 years ago

s0nskar commented 7 years ago

I'm not complaining, but I think NIX project current documentation lacks a lot and I think everyone aware of it. I know adding documentation support for the whole project is quite a daunting task. But least we can do is add a Wiki explaining what each directory contains, what each classes are used for. Even adding a liitle paragraph for description for each will made the life of contributor easy.

jgrewe commented 7 years ago

you did notice the existing wiki ;)

s0nskar commented 7 years ago

I saw that already. But the wiki you mentioned, according to me that only provide like frontend side description like It does not throw any light on implementation containers and design patterns NIX follow. What I want to say, we should add something like this http://g-node.github.io/nix/annotated.html or complete this list. It still lacks many directory/classes definition like what backend/fs and backend/hdf5 are for?

achilleas-k commented 7 years ago

So you mean a developer guide/wiki? Something to help people who want to contribute or develop NIX, instead of a wiki for users.

jgrewe commented 6 years ago

more introductory material and tutorial now available here.