[erlang-questions] Erlang documentation -- a modest proposal

Mark Bucciarelli <>
Fri Sep 23 02:54:15 CEST 2016


On Thu, Sep 22, 2016 at 7:33 PM, Kenneth Lakin <>
wrote:
>
> I'll take this time to point out that https://github.com/erlang/otp/pulls
> exists and -AFAIK- accepts documentation updates.
>

+1

> Initially it can be a little confusing to figure out where the various
> documentation files live.  Remember that the .html files in the online
> documentation are created from .xml files with the same name (but not in
the
> same location) in the Erlang repo. (For example: doc/man/erl_driver.html
is
> created from $ERL_TOP/erts/doc/src/erl_driver.xml.)

Those five lines right there are a PR-in-waiting for (the new file)
otp/HOWTO/WRITE-DOCUMENTATION.md.

Mark

-- 
Blogging at markbucciarelli.com
Tweeting @mbucc
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20160922/de3e02c9/attachment.html>


More information about the erlang-questions mailing list