doc: move misc stuff from README to lib.rs [doc: 2/N] #1290
Conversation
phip1611
changed the title
uefi/src/lib.rs
Outdated
| //! | ||
| //! The full text of the license is available in the [license file][LICENSE]. | ||
| //! | ||
| //! # Trivia and Background |
There was a problem hiding this comment.
I think we should drop this section in the interest of keeping the crate docs focused on the most useful information. The history of UEFI is interesting, but not particularly relevant to developing an app with uefi-rs.
There was a problem hiding this comment.
I just drop the entire paragraph. It is irrelevant. We are already referring to the UEFI spec. This is sufficient
uefi/src/lib.rs
Outdated
| //! of low-level applications. | ||
| //! | ||
| //! Even joke projects such as an [IRC client][uefirc] leveraging only existing | ||
| //! UEFI boot services are possible! 😉 |
There was a problem hiding this comment.
I'd rather leave the IRC client out of the crate docs. (Especially since it's not currently maintained, I wouldn't want to give the impression that users should look there to see how to call uefi-rs.)
As an alternative, I wouldn't be opposed to putting it in the readme if we added a showcase section, e.g. "Projects that use uefi-rs".
There was a problem hiding this comment.
I just drop the entire paragraph. It is irrelevant. We are already referring to the UEFI spec. This is sufficient
We are already referring to the UEFI spec which is sufficient.
Copy MSRV, License, and Contributing sections to lib.rs and streamline it with the README equivalents. We should also include these information in lib.rs, as it is the main entry point into everything relevant about the library. At least, it should from now on. The big benefit is that the documentation on `docs.rs` then covers everything relevant.
This is split-out 2/N from #1264 to improve reviewability.
This moves misc stuff from README to lib.rs
Checklist