News for hackers. Stuff that matters.

A comment on The Problem with Linux Kernel Documentation, and How We're Fixing It. Parent comment

Re:The Problem with Linux Kernel Documentation, and How We'r... by dend on Wednesday September 28, 2016 @04:10PM (#12600897)
The problem with that approach is that you are limiting yourself to fundamentally primitive documentation (and by primitive I mean non-interactive). Granted, for a kernel it might be less important, but it's great when there is a good architecture diagram/image instead of 7 paragraphs.
[ Parent | on HN ]
Re:The Problem with Linux Kernel Documentation, and How We'r... by Sanddancer on Wednesday September 28, 2016 @06:44PM (#12601957)
Manpages can have a rather large amount of interactivity. Documents can be formatted as text, as HTML, with links, etc. The problem is that manpages are an afterthought in too much of the Linux ecosystem, so people have low expectations and low beliefs in what they can actually do. They can have tables, they can have equations, they can have graphics.
[ Parent | on HN ]
Re:The Problem with Linux Kernel Documentation, and How We'r... by dend on Wednesday September 28, 2016 @06:54PM (#12602011)
Out of genuine curiosity, could you link me to an existing guide from the Linux community that is based on manpages and features images and/or other interactive content?
[ Parent | on HN ]
Re:The Problem with Linux Kernel Documentation, and How We'r... by jap on Thursday September 29, 2016 @01:25AM (#12603440)
Not exhaustive, but I've written code that processes 50,000 or so man pages and haven't hit one.
[ Parent | on HN ]