Re: [Ksummit-discuss] [TECH TOPIC] Documentation

Shuah Khan
2019-06-12T18:22:59Z

On 6/12/19 8:54 AM, Jonathan Corbet wrote:
> What could be more fun than talking about kernel documentation? Things we
> could get into:
>
> - The state of the RST transition, what remains to be done, whether it's
> all just useless churn that makes the documentation worse, etc.
>
> - Things we'd like to improve in the documentation toolchain.
>
> - Overall organization of Documentation/ and moving docs when the need
> arises. It seems I end up fighting about this more than just about
> anything else, but I think it's important to organize our docs for the
> convenience of the people using them.
>
> - The ultimate vision for kernel docs (for now). RST conversion and
> imposing some organization are important, but they will not,
> themselves, give us a coherent set of documentation. What can we do to
> have documentation that is useful, current, and maintainable, rather
> than the dusty attic we have now?
>

The first step is identifying the ones that are out of date and/or
incorrect. I think this is probably the most time consuming part
and the second is start updating.

I am currently putting together a task list for mentorship program
with a goal to create tasks that would more meaningful and helpful
instead of whitespace patches.

I will gladly add documentation tasks to the list to help improve
the documentation.

thanks,
-- Shuah