Re: [PATCH v2 2/7] docs: Rewrite the front page
From: Jonathan Corbet
Date: Fri Sep 23 2022 - 15:08:00 EST
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> writes:
> Hi Jonathan,
>
> On 9/22/22 13:41, Jonathan Corbet wrote:
>> The front page is the entry point to the documentation, especially for
>> people who read it online. It's a big mess of everything we could think to
>> toss into it. Rewrite the page with an eye toward simplicity and making it
>> easy for readers to get going toward what they really want to find.
>>
>> This is only a beginning, but it makes our docs more approachable than
>> before.
>>
>> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
>> ---
>> Documentation/index.rst | 150 +++++++++++--------------------
>> Documentation/subsystem-apis.rst | 58 ++++++++++++
>> 2 files changed, 111 insertions(+), 97 deletions(-)
>> create mode 100644 Documentation/subsystem-apis.rst
>
> I don't see a kernel version listed anywhere on the front page
> (maybe it depends on what theme is used?) at
> https://static.lwn.net/kerneldoc/, so I think it needs something like
> this.
>
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -18,6 +18,8 @@ documents into a coherent whole. Please
> documentation are welcome; join the linux-doc list at vger.kernel.org if
> you want to help out.
>
> +This documentation is for Linux kernel $(KERNELRELEASE).
> +
Ah, it does look like we lost that in the transition; I'll make sure it
gets put back.
Thanks,
jon