search

boostorg / website-v2

New Boost website
https://boost.io
Boost Software License 1.0
8 stars 13 forks source link

Warn if library has no Readme #1339

Closed vinniefalco closed 1 week ago

vinniefalco commented 1 month ago

When a library does not have a README.md or README.adoc, the panel should still appear and there should be a message which urges the author or the visitor to contribute one:

"This library has no README.adoc, consider contributing one or send physical mail to the author at 1234 Lane Rd."

GregKaleka commented 1 month ago

I opened a small PR to handle this - open to feedback. I didn't include the physical address bit, since I'm not sure where that info would come from. I don't see any address fields on the library model, nor the User model (where we could grab it from the authors field).

Apologies if the "mail the README" bit is a joke and I'm taking it too seriously 😊.

vinniefalco commented 1 month ago

The problem can be seen here:

image

In between the "This Release" and "All Time" should be a README card, even if there is no README file. And in this case where there is no file we should put up a big sign in flashing lights that says "pretty please...with a cherry on top... add a f'king readme"