Why is there a src/lib.rs file with only comments?

[shawntabrizi]

https://github.com/paritytech/polkadot-sdk-minimal-template/blob/master/src/lib.rs

Why does this file exist in the template?

[rzadp]

These are the docs following the sentiment to use rustdoc and keep readmes as a light intro.
(The readme has been improved a bit since then, but lib.rs stayed as is).

However it doesn't quite work here because the package gets replaced with a workspace root. And the template crates are not published to any registry, so there is no way to read those rustdocs without cloning the repo (e.g. on mobile).

So for these reasons I think templates should be the exception and avoid rustdocs for introductory documentation, instead have it right in the readme - so we can remove lib.rs (or integrate into the readme file).

@gupnik Do you agree with that?

[shawntabrizi]

I agree, if your auto-generation process can remove this, it makes sense to me.

[kianenigma]

the only place they can be seen is in https://paritytech.github.io/polkadot-sdk/master/minimal_template/index.html

I think these were added when the template had no good readme. Now that it has, they can be removed, or bere a mere duplicate of the readme include_str!("./README.md").