From: Daniel Stenberg Date: Mon, 4 Mar 2024 22:04:05 +0000 (+0100) Subject: CONTRIBUTE: update the section on documentation format X-Git-Tag: curl-8_7_0~90 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6f685f04fd3780a19707703c4095db1d60035202;p=thirdparty%2Fcurl.git CONTRIBUTE: update the section on documentation format ... since most of it is markdown now. Closes #13046 --- diff --git a/.github/scripts/spellcheck.words b/.github/scripts/spellcheck.words index 1c408f03aa..d851228688 100644 --- a/.github/scripts/spellcheck.words +++ b/.github/scripts/spellcheck.words @@ -451,6 +451,7 @@ makefiles malloc mallocs manpage +manpages maprintf Marek Mavrogiannopoulos diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md index 24928116c8..6288dac90d 100644 --- a/docs/CONTRIBUTE.md +++ b/docs/CONTRIBUTE.md @@ -105,9 +105,10 @@ projects but someone's gotta do it. It makes things a lot easier if you submit a small description of your fix or your new features with every contribution so that it can be swiftly added to the package documentation. -The documentation is always made in man pages (nroff formatted) or plain -ASCII files. All HTML files on the website and in the release archives are -generated from the nroff/ASCII versions. +Documentation is mostly provided as manpages or plain ASCII files. The +manpages are rendered from their source files that are usually written using +markdown. Most HTML files on the website and in the release archives are +generated from corresponding markdown and ASCII files. ### Test Cases