Ggez: Are badges in ggez's top level doc comment really required?

[ozkriff]

https://github.com/ggez/ggez/blob/f3592d613/src/lib.rs#L2-L7

They look weird when generating offline documentation:

[icefoxen]

Good point. They exist in the README.md and the module doc comments are just a copy of that, so the badges get carried along with that. Might be worth removing them though.

I wonder if we can auto-generate this somehow, so we don't have to keep the docs in sync in two places.

[ozkriff]

Are you sure that these documents must be synchronized?

README serves for "selling" a project to a potential user and top-level doc comment is just an intro to the documentation. I think that they should focus on different things. For example, what's the point in having "Features" and "Help!" sections in the doc comment?

[ozkriff]

I wonder if we can auto-generate this somehow, so we don't have to keep the docs in sync in two places.

All I can google is this https://github.com/rust-lang/rust/pull/44781

[icefoxen]

Removed the badges in 693d3d6, but some sort of auto generation would really be ideal.

[icefoxen]

As of commit c090ee1, intro library docs are more concrete and minimal, while the readme is a bit more pick-up-and-go. It could use a bit more refining but I'm calling this part done.