From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: "John Snow" <jsnow@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: Re: [PATCH 1/1] docs/qapi-domain: Improve QAPI indices
Date: Thu, 24 Jul 2025 11:35:34 +0200 [thread overview]
Message-ID: <87o6taorrt.fsf@pond.sub.org> (raw)
In-Reply-To: <87qzy6qc5p.fsf@pond.sub.org> (Markus Armbruster's message of "Thu, 24 Jul 2025 09:29:54 +0200")
Alright, that was a tad long. Here's the shortest feedback I can give.
Thesis: the prime use case for the index is looking up commands and
events. See my long reply for why.
Usability baseline: an index page with links "A", ... "Z" at the top,
each linking to a flat list of commands and events starting with that
letter, in case-insensitive alphabetical order.
The longest list is "Q": 83 entries. Most lists are 20 entries or less.
Whatever index page design we choose, it should not be substantially
worse in usability for the prime use case than this baseline.
prev parent reply other threads:[~2025-07-24 10:02 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-23 18:08 [PATCH 0/1] Sphinx: refactor QAPI indices John Snow
2025-05-23 18:08 ` [PATCH 1/1] docs/qapi-domain: Improve " John Snow
2025-06-02 11:16 ` Daniel P. Berrangé
2025-06-05 8:46 ` Markus Armbruster
2025-06-05 16:36 ` John Snow
2025-06-13 21:07 ` John Snow
2025-07-24 7:29 ` Markus Armbruster
2025-07-24 9:35 ` Markus Armbruster [this message]
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=87o6taorrt.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.