<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
    <p><br>
    </p>
    <div class="moz-cite-prefix">On 21/05/19 11:13, Petr ┼átetiar wrote:<br>
    </div>
    <blockquote type="cite"
      cite="mid:20190521091326.GK63920@meh.true.cz">
      <pre class="moz-quote-pre" wrap="">Linus Walleij <a class="moz-txt-link-rfc2396E" href="mailto:linus.walleij@linaro.org"><linus.walleij@linaro.org></a> [2019-05-20 23:48:41]:

[adding Alberto, Thomas and Javier to the Cc: loop]

</pre>
      <blockquote type="cite">
        <pre class="moz-quote-pre" wrap="">how you want the sysupgrade to work.
</pre>
      </blockquote>
      <pre class="moz-quote-pre" wrap="">
it's just preferred to share as much common code as possible.

</pre>
      <blockquote type="cite">
        <pre class="moz-quote-pre" wrap="">Maybe we could open a documentation page for new devices, like here is how
we want you to implement sysupgrade, I had a hard time to figure out that
all was circuling around the platform.sh script and how that was called from
the core sysupgrade.
</pre>
      </blockquote>
      <pre class="moz-quote-pre" wrap="">
indeed, some documentation would be certainly nice and welcome, but I think,
that it's clear, that having the documentation decoupled from the code (wiki
today) leads often to outdated (incomplete, even factually wrong or misleadin)
documentation which might be even more confusing for the starters then current
"read the code Luke" approach.

I mean, maybe this is the right time to rethink[1,2], so we could have
docs/Documentation folder in the source tree, like it's done in the kernel and
other projects.

1. <a class="moz-txt-link-freetext" href="https://lede.readthedocs.io/en/latest/">https://lede.readthedocs.io/en/latest/</a>
2. <a class="moz-txt-link-freetext" href="https://lists.openwrt.org/pipermail/openwrt-devel/2017-November/009888.html">https://lists.openwrt.org/pipermail/openwrt-devel/2017-November/009888.html</a>

-- ynezz
</pre>
    </blockquote>
    <p><br>
    </p>
    <p>The only clear thing is that documentation does not write itself
      and that <br>
    </p>
    <p>you can't rely on users to write developer documentation.</p>
    <p>Where it is kept is irrelevant, what is relevant is that people
      doing commits</p>
    <p>(members and contributors) actually write it and keep it updated
      wherever it is kept.</p>
    <p><br>
    </p>
    <p>I'd like to point out that it was yours truly that deleted the
      documentation <br>
    </p>
    <p>folder in the current OpenWrt tree <br>
    </p>
    <p>with commit <span class="sha-block"><span class="sha
          user-select-contain">882f4d2d63272abce8c1966983aa10178e2e971f</span></span></p>
    <p><span class="sha-block"><span class="sha user-select-contain">as
          it was horribly outdated and completely useless <br>
        </span></span></p>
    <p><span class="sha-block"><span class="sha user-select-contain">(and
          we got people rightfully complaining about it in the forums).<br>
        </span></span></p>
    <p><span class="sha-block"><span class="sha user-select-contain"><br>
        </span></span></p>
    <p><span class="sha-block"><span class="sha user-select-contain">-Alberto.</span></span></p>
  </body>
</html>