Re: Documentation Updating

[Nick Craig-Wood]

As a new user (new to both contesting and tlf) I was thinking about 
helping with the docs too.

I thought I'd add my fresh-eyes perspective on the docs here.

I could have done with some better getting started instructions. The 
best ones I've found are here: 
http://home.iae.nl/users/reinc/tlf/tlfdoc-0.9.9/tlfdoc.html under the 
"Directory structure" section which says

> It is good practise to use separate directories for the different 
contests.

Which was a major step in working out how to use tlf which isn't spelled 
out in the man page. There is a lot of obsolete stuff in those docs though.

I think it would be good for the project to have nice looking online 
docs. In another project I'm involved in (rclone) we use markdown for 
the docs and convert that into man pages and the website. The website is 
the primary documentation method, but all the information is in the man 
page too. I like this way of working because there is only one source 
for the documentation - the markdown files - and everything else is 
built from there. I could certainly help with this if people thought it 
was a good idea. I'm not much of a technical writer, but I'm a better 
software developer ;-)

I just want to say thank you to all the developers of tlf - I know how 
hard Open Source software is!

73

Nick 2E0WPM
--
Nick Craig-Wood <nick@craig-wood.com> -- http://www.craig-wood.com/nick