Re: [PATCH] Documentation: index: Minor re-arrangement and improvements

From: Dhruva Gole
Date: Wed Jan 24 2024 - 01:21:27 EST


On Jan 23, 2024 at 14:51:27 -0700, Jonathan Corbet wrote:
> Dhruva Gole <d-gole@xxxxxx> writes:
>
> > * It seems odd that a develper is forced to look at the licensing rules
> > even before they get to the doc or coding guide.
> > This belongs under the "Working with the development community" / "All
> > development docs" page where it does reside even today.
> > * Rearrange the section for Internal API manuals to go lower because
> > generally one would want to look at the tools and processes and admin
> > guide pages first and then move onto something deeper like the API
> > manuals.
> > * Reword the Dev tools section and title to something a bit more suitable.
> >
> > Signed-off-by: Dhruva Gole <d-gole@xxxxxx>
>
> As a general rule, multiple items in the changelog like this suggest
> that you need to break a patch up.

I understand, can break this patch up if required.

>
> In this case, though, I guess I don't see the reason why we would want
> to churn this page this way. The ordering of the items on the front
> page was thought through and discussed the last time we did this; why
> should we revisit it now?

The changes from "docs: Rewrite the front page[0]" are indeed great
however I saw a little more scope for improvement and thus decided to patch

Let me know how you think we should proceed.

[0] https://lore.kernel.org/r/20220927160559.97154-3-corbet@xxxxxxx

>
> Thanks,
>
> jon

--
Best regards,
Dhruva Gole <d-gole@xxxxxx>