Re: [PATCH 0/1] docs: Include simplified link titles in main page's index

[Carlos Bilbao]

On 12/21/23 00:11, Randy Dunlap wrote:
> On 12/20/23 21:59, Vegard Nossum wrote:
> > On 15/12/2023 16:47, Jonathan Corbet wrote:
> > > Carlos Bilbao <bilbao@xxxxxx> writes:
> > >
> > > > The general consensus is that the documentation's website main entry point
> > > > and its sidebar leave room for improvement.
> > [...]
> > > Meanwhile, I'm pondering on this patch, would like to know what others
> > > think.  Carlos nicely put up some comparison images for us:
> > >
> > >     https://github.com/Zildj1an/linux-kernel-docs-compare/blob/main/comparison.png
> >
> > FWIW, I like it, but I would suggest these changes:
> >
> > Driver implementation API -> Driver APIs
> > Testing -> Testing guide
> > Hacking -> Hacking guides
> > User-space tools -> Userspace tools
> > User-space API -> Userspace APIs
> > CPU Architectures -> CPU architectures
> >
> > I know "user space" is technically two words, but the one-word form is
> > MUCH more prevalent in the kernel, for example if you check the mainline
> > log you'll see something like:
> >
> > $ git log --grep 'user.*space' | grep -o 'user.*space' | sort | uniq -c | sort -g | tail -n 3
> >     3135 user-space
> >     7835 user space
> >    26917 userspace
> >
> > I think it makes sense to pluralize API -> APIs in most places, so e.g.
> > "Core APIs", "Driver APIs", "Userspace APIs". Just to emphasize that
> > these are really collections of disparate APIs (e.g. workqueues is one
> > API, linked lists is another, etc.).
>
> +1 for all suggestions.

These are good suggestions, sending v2.

> Thanks.

Thanks,
Carlos