search

erlef / documentation-wg

EEF Documentation Working Group
9 stars 1 forks source link

WG Report - May 2020 #5

Closed josevalim closed 4 years ago

josevalim commented 4 years ago

Hi everyone,

We were asked to make a report on the WG recent efforts. Part of it will also be a video to be presented at CodeBEAM. I think we should touch four topics:

  1. Erlang/OTP 23 supports EEP 48 and discuss the new helpers in the terminal (thanks to the Ericsson team)
  2. Edoc is being worked on by Radek to also follow EEP 48 (show a link where people can try it out)
  3. Elixir master supports reading/showing Erlang docs in the terminal
  4. ExDoc is being improved to generate docs for Erlang projects too, v0.22 already has some improvements in this direction

Anything else?

erszcz commented 4 years ago

Hi José,

This looks good to me. Please let me know if we need more details than one bullet point.

niedz., 17 maj 2020 o 10:14 José Valim notifications@github.com napisał(a):

Hi everyone,

We were asked to make a report on the WG recent efforts. Part of it will also be a video to be presented at CodeBEAM. I think we should touch four topics:

  1. Erlang/OTP 23 supports EEP 48 and discuss the new helpers in the terminal (thanks to the Ericsson team)
  2. Edoc is being worked on by Radek to also follow EEP 48 (show a link where people can try it out)
  3. Elixir master supports reading/showing Erlang docs in the terminal
  4. ExDoc is being improved to generate docs for Erlang projects too, v0.22 already has some improvements in this direction

Anything else?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/erlef/documentation-wg/issues/5, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAA3MEPNVB6VX4GAJ35WEO3RR6MFLANCNFSM4NDI25YA .

KennethL commented 4 years ago

Looks good to me.

I can suggest that we say that : The Erlang Ecosystem Foundation have worked as a trigger and platform for creating cooperation and drive forward for specific topics. In this case a "standardized way" to handle API documentation. Most of the man hours spent have been "sponsored" by the developers employers.

I made a picture for my own team several months ago and it might be useful now. I can refresh and provide it in other formats it if you think it is useful.

/Regards Kenneth

On Sun, May 17, 2020 at 10:14 AM José Valim notifications@github.com wrote:

Hi everyone,

We were asked to make a report on the WG recent efforts. Part of it will also be a video to be presented at CodeBEAM. I think we should touch four topics:

  1. Erlang/OTP 23 supports EEP 48 and discuss the new helpers in the terminal (thanks to the Ericsson team)
  2. Edoc is being worked on by Radek to also follow EEP 48 (show a link where people can try it out)
  3. Elixir master supports reading/showing Erlang docs in the terminal
  4. ExDoc is being improved to generate docs for Erlang projects too, v0.22 already has some improvements in this direction

Anything else?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/erlef/documentation-wg/issues/5, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABFWSAQ47ZGDFMJNGG73ATRR6MFLANCNFSM4NDI25YA .

josevalim commented 4 years ago

Please include the picture or e-mail me if possible @KennethL, thanks!

KennethL commented 4 years ago

Hi José,

I have attached the small powerpoint file which includes the picture. I can also provide it in other formats, .pdf, .odp if that is more convenient.

/Kenneth

On Mon, May 18, 2020 at 12:49 PM José Valim notifications@github.com wrote:

Please include the picture or e-mail me if possible @KennethL https://github.com/KennethL, thanks!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/erlef/documentation-wg/issues/5#issuecomment-630102374, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABFWSHPZUFDKNKBGSZJVP3RSEHB5ANCNFSM4NDI25YA .

josevalim commented 4 years ago

@KennethL I think GitHub does not allow attachments via email. So please e-mail them to me directly if possible. :) Thanks.