On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote: > I'd argue we can add NOTES.md to packages (e.g. allow those files.) > Then we modify packages.gentoo.org to render the markdown; or users > can render locally or read unrendered. > > WDYT?
Given this topic came up again on IRC, late reply to say that some kind NOTES of file in the tree is my preference over metadata.xml at the moment. I don't feel strongly about being rendered somewhere though, a dev will see the file in the tree if they work on the package (partly because of that I'd also rather rst over md for bit better plain-text readability, but can work with either). Seeing the file is main reason I prefer this over metadata.xml, making it clear there's notes without needing any tools integration to parse metadata.xml and remind about. fwiw given these are entirely for devs they could even be skipped from sync mirrors so users don't get them and think it's something they need to read (+less files), but no strong opinion here. -- ionen
signature.asc
Description: PGP signature
