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

Kenneth Lundin <>
Mon Sep 26 14:13:51 CEST 2016


...

In your initial comment, you said "If I see a typo", not "if my wife sees a
typo" :-)

>
> I suppose your wife isn't very used to downloading the 240 MBytes,
> unpacking them, fixing the file and publishing the change, either. This was
> the scenario for which I suggested a simpler alternative.
>
> There is an even better way, actually, even if it still requires a Github
> account in its current form. I don't remember where I saw it first, but I
> use it for the erlide documentation (which I am well aware that is lacking
> in all other respects): each generated page has at the bottom the message
> shown below, where the link opens the source file (markdown, in this case)
> from which it was generated in the on-line Github editor. This is something
> that could be added to the OTP docs too (but hand-editing Docbook XML is
> not as much fun as it sounds like :-\ )
>

The XML markup used for the Erlang documentation is not Docbook. We use our
own DTDs with much more lightweight markup than Docbook.


>
> > Did you find errors in the documentation? Do you have improvements to
> suggest? Suggest edits!
> <https://github.com/erlang/erlide_eclipse/edit/master/org.erlide.help/articles/eclipse/250_Editor.md>
>
> best regards,
> Vlad
>
>
>
/Kenneth, Erlang/OTP, Ericsson

>
> _______________________________________________
> erlang-questions mailing list
> 
> http://erlang.org/mailman/listinfo/erlang-questions
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20160926/03eba24b/attachment.html>


More information about the erlang-questions mailing list