[annotator-dev] Annotator 2.0 Docs

Tue Jan 7 08:50:54 UTC 2014

On 06.01.14 20:18, Randall Leeds wrote:
> I'm in. Do we want to start putting docs in the source so they can stay
> more up-to-date? I'm happy to help get the initial tooling sorted out and a
> page written so the pull requests can start coming.

I'm for documentation files in the code repo as long as the
documentation is plain.

In my digilib project I had the full website in the repo at one time but
that made the repo too big when you just wanted to get to the code. Then
I took all documentation out.

Now I put the documentation back in as bare-bones Markdown files and the
website is built with Maven's site plugin. I guess that would be
similar to the solution you would use on github.

Cheers
	Robert

> On Mon, Jan 6, 2014 at 9:39 AM, Andrew Magliozzi <andrew at finalsclub.org>wrote:
> 
>> Hey Nick and company,
>>
>> I hope you all had a good holiday break.
>>
>> I'm writing to kickstart the documentation for Annotator 2.0.  If anyone
>> wants to collaborate on this with me, I could certainly use some help.
>>  @Nick, can you give us some idea of the specific needs for documentation
>> so we can get started.
>>
>> Thanks!
>> Andrew