[OpenWrt-Devel] Documentation in the tree? [Was: Re: [PATCH v3] gemini: Support sysupgrade on DIR-685]

[Petr Štetiar]

Alberto Bursi <bobafetthotmail at gmail.com> [2019-05-21 11:37:31]:

> The only clear thing is that documentation does not write itself and that
> you can't rely on users to write developer documentation.

You actually can enforce it somehow, as you either include/update
documentation to reflect your changes or your contribution won't be considered
for merge/review.

It's not a panacea, but it works relatively well in the kernel (DT docs for
example).

> with commit 882f4d2d63272abce8c1966983aa10178e2e971f
> as it was horribly outdated and completely useless

Maybe, that at that time GitHub considered Tex binary format and thus wouldn't
allow web based PRs, thus limiting potential contributions? :-)

I think, that you either have approachable documentation format(Markdown/ReST)
and tooling around, which would allow easy contributions or you end up with
the outdated documentation.

-- ynezz

_______________________________________________
openwrt-devel mailing list
openwrt-devel at lists.openwrt.org
https://lists.openwrt.org/mailman/listinfo/openwrt-devel