Re: Documentation Updating

[Thomas Beierlein]

Seems the ball is rolling :-). Fine.

Having the main documentation distributed with TLf in the main repo
seems sensible.

Regards Ervins idea of an additional repo I would recommend the
existing tlf.github.io for any web page related documents. These
documents are easily rendered as GH pages by github.

While the discussion at the moment goes in the direction of using
markdown I learned that asciidoc is an alternative which has a little
bit more features which may be helpful. It can just as easily converted
to text, PDF files or html pages (and can even be used to produce man
pages :-) ). See for instance the WSJT-X suite - they generate their
whole documentation that way.

Just my 2 c. But anyway, I am fine with both.
 
73, de Tom

Am Wed, 23 Feb 2022 15:12:58 -0500
schrieb Alan Dove <alan@alandove.com>:

> Hey, folks:
> 
> Ervin, I can't read a word of Hungarian, but I'll trust that you've
> done fine work there. I don't favor splitting the documentation into a
> separate project. Let's keep it in the main Github repository and try
> to stick with (or move things into) Markdown for the reasons already
> outlined. I'm fine with keeping the man pages separate from the
> Markdown documentation, as it does make some sense to expect people to
> use the two types of references differently.
> 
> My focus so far has been to consolidate as much of the information as
> possible into as few files as seems sensible. I've overhauled the main
> README.md and INSTALL.md, and have now created doc/Manual.md, where
> I've pasted the text from the separate files that used to be in that
> directory. I'll hold off filing a pull request until I've done at
> least one more editing pass through everything.
> 



-- 
"Do what is needful!"
Ursula LeGuin: Earthsea
--