]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CONTRIBUTE: update the section on documentation format
authorDaniel Stenberg <daniel@haxx.se>
Mon, 4 Mar 2024 22:04:05 +0000 (23:04 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 5 Mar 2024 09:53:21 +0000 (10:53 +0100)
... since most of it is markdown now.

Closes #13046

.github/scripts/spellcheck.words
docs/CONTRIBUTE.md

index 1c408f03aa2b411bedaafb61da8c82356e84ecaf..d851228688fce003f25ad20bb192b7046fb1321e 100644 (file)
@@ -451,6 +451,7 @@ makefiles
 malloc
 mallocs
 manpage
+manpages
 maprintf
 Marek
 Mavrogiannopoulos
index 24928116c85132cd0fe45ef2958030630d8fd28b..6288dac90d20e62442875a603efa993f0309a7bb 100644 (file)
@@ -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