From: Jonathan Corbet <corbet@lwn.net>
To: Akira Yokosawa <akiyks@gmail.com>, rdunlap@infradead.org
Cc: akiyks@gmail.com, davidgow@google.com, linux-doc@vger.kernel.org,
sadiyakazi@google.com
Subject: Re: [PATCH RFC V2] docs: Add more information to the HTML sidebar
Date: Thu, 16 Feb 2023 16:55:08 -0700 [thread overview]
Message-ID: <87fsb5go83.fsf@meer.lwn.net> (raw)
In-Reply-To: <f242e068-2126-c67e-c894-7a1727b1d2b7@gmail.com>
Akira Yokosawa <akiyks@gmail.com> writes:
> I think the patch appended below (on top of current docs-next)
> would have been a better approach, where each .rst file is listed
> only once in the whole toctree. The refurbished part of main index
> is moved to index-frequent.rst and toctrees are replaced with
> lists of :doc: references.
>
> Per-directory indexes are listed in the main index's toctree
> below the index-frequent.
>
> I'm not saying this is "the" right approach.
> There can be many ways to accomplish the same result, I suppose.
>
> I'll submit this change as a proper patch if I can get positive
> feedback.
So I applied this and built it. There may be potential in this
approach, but I don't think we are there yet.
This change completely loses the organization that I wanted to put onto
the front page itself. That page will be the place where people land
first, so it should guide them to somewhere useful as quickly and easily
as possible. With this change, we've hidden that guidance in a
subsidiary page and the front is back to a random collection of
unordered stuff.
The front page, I think, is more important than the sidebar.
We really need to look into the actual generation of the sidebar; it's
on my list, but won't happen before the merge window. I do appreciate
playing with ideas, though - please keep it up! We'll figure out
something eventually...:)
Thanks,
jon
next prev parent reply other threads:[~2023-02-16 23:55 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-03 23:09 [PATCH RFC V2] docs: Add more information to the HTML sidebar Jonathan Corbet
2023-02-04 0:02 ` Jonathan Corbet
2023-02-04 0:20 ` Akira Yokosawa
2023-02-04 7:33 ` Akira Yokosawa
2023-02-04 21:39 ` Jonathan Corbet
2023-02-04 0:02 ` Randy Dunlap
2023-02-06 19:25 ` Jonathan Corbet
2023-02-14 18:25 ` Randy Dunlap
2023-02-14 18:33 ` Jonathan Corbet
2023-02-15 10:23 ` Akira Yokosawa
2023-02-16 23:55 ` Jonathan Corbet [this message]
2023-02-04 4:36 ` David Gow
2023-02-06 11:22 ` Sadiya Kazi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87fsb5go83.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=davidgow@google.com \
--cc=linux-doc@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=sadiyakazi@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox