Mail archive

Re: [alpine-devel] Improving Alpine Linux documentation

From: William Pitcock <>
Date: Tue, 12 Dec 2017 16:05:24 -0600


On Tue, Dec 12, 2017 at 2:23 PM, Drew DeVault <> wrote:
> I don't really have any advice for what to do with the wiki, but
> regarding Alpine's core documentation I have some thoughts. Something
> that bothers me about Alpine (and that I'd like to contribute to
> improving) is the lack of man pages for Alpine core stuff. I think a
> substantial portion of the core docs can and should be done this way,
> rather than on the wiki - though it would be nice to render the man
> pages to HTML for display on the web, too.
> No one likes writing roff so I've been working on a tool recently to
> help with this:

I don't mind writing roff with the mdoc macro package. It seems fine to me.

> If there's no opposition to this I was hoping to start writing man pages
> for apk shortly.

We prefer to have apk's documentation in mdoc, since it does not
require any preprocessing, but maybe your tool can be useful for other
Alpine projects.


Received on Tue Dec 12 2017 - 16:05:24 UTC