Support #1672
Documentation: a good model to follow?
Description
I found the following link which claim that Arch Linux doc is particularly well written:
https://www.theregister.com/2022/03/15/arch_linux_20/
Can we learn something from this?
Related issues
History
#1
Updated by John Abbott 2 months ago
Updated by - Target version changed from CoCoALib-0.99850 to CoCoALib-0.99900
Here is a list of features it would be nice to offer in the CoCoALib documentation:
- cross-references (xrefs)
- smaller and/or more structured HTML pages (some are getting long)
- C++ code excerpts -- I know we have links to example programs, but often the interesting part is just a handful of lines in a longish file. I quite like the way cppreference is organized -- it is good for looking things up; maybe not so good as a "bedtime read"
- what format(s) do we want to offer the documentation in? Currently the source is .txt files which are converted to HTML and LaTeX/PDF -- does anyone use the PDF version? Are there "hyperlinks" in the PDF file?
- I think we have done a pretty good job with the doc for CoCoA-5. What can we learn from that? Could we mimic the features there in HTML? (most of them, I think so)
#2
Updated by Anna Maria Bigatti about 2 months ago
Updated by - Related to Design #1783: Code & doc structure: one-big-file or many-small-files? added