dokan-dev / dokany

User mode file system library for windows with FUSE Wrapper
http://dokan-dev.github.io
5.2k stars 661 forks source link

Clean up the documentation #341

Open magol opened 7 years ago

magol commented 7 years ago

Today, the documentation is scattered in many places

Place Dokany Dokan-dotnet
Doxygen Dokany dokan-dotnet
Wiki Dokany None
README.md Dokany Dokan-dotnet
Website All

There is no clear coupling between the various sites, the information is redundant, it is hard to find among the various sites, it is difficult to keep so many places up to date.

It must be possible to simplify in any way. dokan-dev.github.io should be enough as it is, it presents the product in a simple manner. The question is where all technical information should be?

Suggested solution

Rondom commented 7 years ago

I think the Wiki has its place and the Doxygen documentation has its place. Wikis provide a lower barrier to entry for people to edit information. Whether there is some content that better belongs to one of the other place is of course debatable and probably should be discussed ;-) I agree that the README has quite a bit of information that is better kept at other places.

I actually have done some research about this already. We could generate the documentation-part of the website from the Wiki and link to GitHub for editing. Synchronisation (i.e. generation of the website) can either happen manually (after review) or automatically. Just using the wiki as a git-submodule does not work because Jekyll expects some header in every file (but maybe one can add that in the wiki... who knows....).

Given that the Doxygen-documentation already uses Bootstrap it should not be too difficult to make it blend with the website. See also my comment on the previous issue for some ideas. #313.

Also we could generate a more user-friendly user-interface for the releases and another one nightly builds as well. Currently it is for example not really clear what the differences between DokanSetup.exe and DokanSetup_redist.exe are and a "real" download page would help in that regard.