sling-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Oliver Lietz <apa...@oliverlietz.de>
Subject Re: documentation locations
Date Tue, 23 Jan 2018 14:40:43 GMT
On Tuesday 23 January 2018 13:54:30 Jason Bailey wrote:
> Is there a determination on where the true source of documentation is?
> We have the sling-site project, we have the README in each individual
> project and the plugins are using the maven-sites-plugin.

AFAIR we agreed on having basic documentation in the README and higher level 
documentation or documentation spanning multiple modules on Sling's site under 
/documentation.
 
> In Git projects it's usually the README or a unique docs folder. In a
> related note, if the README isn't being used for documentation, what should
> be in there?

A link to the documentation.

HTH,
O.


Mime
View raw message