Precedence: list
MIME-Version: 1.0
In-Reply-To: <20171212202301.GA26329@miku>
References: <20171212201302.GA9334@eddy> <20171212202301.GA26329@miku>
From: William Pitcock <nenolod@dereferenced.org>
Date: Tue, 12 Dec 2017 16:05:24 -0600
Message-ID: <CA+T2pCG0f6S9R70kca3GMX03g886ZsiJ8rRb4AoUt4hjCmsL4g@mail.gmail.com>
Subject: Re: [alpine-devel] Improving Alpine Linux documentation
To: Drew DeVault <sir@cmpwn.com>
Cc: Consus <consus@ftml.net>, alpine-dev <alpine-devel@lists.alpinelinux.org>
Content-Type: text/plain; charset="UTF-8"

Hi,

On Tue, Dec 12, 2017 at 2:23 PM, Drew DeVault <sir@cmpwn.com> 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.

> https://git.sr.ht/~sircmpwn/scdoc
>
> 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.

William


---
Unsubscribe:  alpine-devel+unsubscribe@lists.alpinelinux.org
Help:         alpine-devel+help@lists.alpinelinux.org
---