You are here:
(11 Apr 2016,
<noautolink> ---+!! Hack The Docs %TOC% "Hack The Docs" is a collaborative editing project, focused on improving Elixir's online documentation. This page summarizes the project's objectives, approach, and schedule. ---++ Objectives Elixir's documentation entries (eg, =@doc=, =@moduledoc=) vary in quality. Some are clear, comprehensive, and useful; others, not so much. Making all of the documentation perfect is an unrealistic goal, but we can (and should!) improve the most neglected cases. Ideally, each =@doc= entry should contain: * a clean, clear description of the function's purpose * at least one working example, preferably in IEx format *Note:* The discussion above is framed in terms of functions. Adjust accordingly for exceptions, macros, modules, protocols, etc. ---++ Approach Volunteers gather (either physically or virtually) to work on the Elixir documentation. Attendees tackle sections (eg, the Atom Module), adding examples, clarifying text, improving the format, removing cruft, etc. Virtual meetings are held on IRC ([[irc://irc.freenode.net/elixir-lang][#elixir-lang]]). Physical meetings can be anywhere; feel free to [[#Schedule][schedule]] one! Anyone is welcome (nay, encouraged!) to work on any part of the documentation. However, to assist in coordination, there is a status page for each currently active area. Please use this page to indicate the fact that you are working on (say) a module: * [[ESL][Elixir Standard Library]] Plausible results go, as usual, to GitHub. Per José Valim: <blockquote> There isn't much process. Just send a pull request that follows generally known guidelines, like: 1. Good commit messages 1. Focused: you should, for example, keep your changes in a single chapter<br> (unless you are doing something structural to all of them). </blockquote> *Note:* Please see the [[Editing_HowTo][Editing HowTo]] for detailed instructions. <!-- ---++ Calendar Meetings are announced here, on the [[%elt_list%][elixir-lang-talk]] mailing list, and on assorted meetup pages (eg, %erlang_sv%, %erlounge%). * Thursday, February 19 (6:30-9:30 pm) in Mountain View, CA<br> (see [[%WMC%/Erlang-SV/events/220464608][Elixir/Erlang Hack Night]] at %erlang_sv%) * Sunday, February 22 (1:30-4:30 pm) in San Francisco, CA<br> (see [[%WMC%/ErlangSF/events/220173459][Hack the Docs]] at %erlounge%) * Sunday, March 22 (1:30-4:30 pm) in San Francisco, CA<br> (see [[%WMC%/ErlangSF/events/220468167][Hack the Docs]] at %erlounge%) --> <!-- * Set WMC = http://www.meetup.com * Set WP = https://en.wikipedia.org/wiki * Set elt_list = https://groups.google.com/forum/#!forum/elixir-lang-talk * Set erlang_sv = [[http://www.meetup.com/Erlang-SV/][Elixir/Erlang SV]] * Set erlounge = [[http://www.meetup.com/ErlangSF/][ErLounge SF/Bay]] * Set meetup = Elixir/Erlang Hack Night * Set table_opts = cellpadding="1" dataalign="left,center,center,left" sort="on" * Set title_end = | * Count * | * Status * | * Volunteer Names * | * Set twisty_opts = showlink="Show" hidelink="Hide" remember="on" start="show" --> %ZB%
ore topic actions
Topic revision: r48 - 11 Apr 2016,
Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
, Plugin API version
Ideas, requests, problems regarding CFCL Wiki?
Send us email