Re: [PATCH v2] README: Don't organize the README by arbitrary "roles"

From: Kees Cook

Date: Wed May 13 2026 - 21:47:12 EST


On Thu, May 14, 2026 at 12:09:46AM +0000, Runxi Yu wrote:
> More broadly though, I'm a little skeptical in whether the README is the
> proper place to put extensive links to different subsystems/parts of the
> documentation. Sphinx has the ability to generate table of contents, and
> we could also improve the index over there, with the TOC/whatever that
> it could generate. I don't think we should be duplicating this into the
> README, but if that ship has sailed, this patch might still be useful.

I don't agree with this change at all. This modern layout of the README
was discussed at length. The "role" sections are very intentional.

-Kees

--
Kees Cook