romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-07-24 16:07:16 +03:00
Code Issues Projects Releases Packages Wiki Activity

CONTRIBUTE: update the section on documentation format

Browse source 
... since most of it is markdown now.

Closes #13046
This commit is contained in:
Daniel Stenberg 2024-03-04 23:04:05 +01:00
parent 07b667567f
commit 6f685f04fd
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.github/scripts/spellcheck.words vendored
View file

@ -451,6 +451,7 @@ makefiles
malloc
mallocs
manpage
manpages
maprintf
Marek
Mavrogiannopoulos

7
docs/CONTRIBUTE.md
View 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