Regarding the consistency with other log4<X> projects, I as a .NET
developer and log4net user, consider consistency with other .NET
documentation (aka MSDN-Style) much more important then with let's say
log4j.
I don't think either that we should re-style the SDK reference. The
issue we try to solve here is that we currently have to place deep links
into the generated MSDN-Style SDK reference sites and we regularly break
those links from one release to the next. Options we have so far are:
1) link to the SDK reference index page
2) write parts of the documentation in the site
3) generate parts of the website from the source code documentation
While (1) is trivial, users have to read the SDK reference to know all
the available configuration options. It is fine by me, but the starter
of this topic was unable to do so and therefore we should try to make
this better. (2) is trivial too, but we have to synchronize the SDK
documentation with the website which means more effort over the years.
(3) is not trivial, sophisticated and much more initial work, but gives
the same result as (2) without the need to duplicate the effort of
maintenance.
We already have the MAML and we try to find a way to "Create the
conceptual content" as mentioned at [1]. For now this is an completely
abstract task to me but [2] should give more insights. Hints, ideas,
help and patches welcome! :-)
Cheers,
Dominik
[1]
http://ewsoftware.github.io/MAMLGuide/html/303c996a-2911-4c08-b492-6496c82b3edb.htm
[2]
http://ewsoftware.github.io/MAMLGuide/html/86752a38-eba3-4174-bcbf-79ec8428ecf9.htm
