search

aide / aide.github.io

AIDE website
https://aide.github.io
7 stars 10 forks source link

[Feature request] Rewrite of the AIDE documentation #21

Open mdziczkowski opened 1 year ago

mdziczkowski commented 1 year ago

Hello. I would like to request and propose that the AIDE documentation would become re-wroten if nessecarry then even from scratch ;-) ).

In my proposal, it would be a good idea to split the documentation into sections, with would contain the full reference (it can be done as separate files for better visibilty) of:

Proposed above would make things much easier who are just starting with or are switching to AIDE from other software. Please add also a link t it on the main project website

hvhaugwitz commented 1 year ago

Hello. I would like to request and propose that the AIDE documentation would become re-wroten if nessecarry then even from scratch ;-) ).

With AIDE documentation you mean the (outdated) "AIDE manual" available under aide.github.io/doc/ ?

* command line (CLI) of aide and aideinit

aideinit is not part of upstream (it belongs to the Debian package).

Please add also a link t it on the main project website

Currently the "AIDE manual" is not linked on the main website because it is outdated.

mdziczkowski commented 1 year ago

Hello. Any chance that the doc get upgraded or re-done ?

hvhaugwitz commented 1 year ago

Yes, I plan to update the documentation at some future time.

mdziczkowski commented 1 year ago

ok, hopefully you will find enough time for it 😉