doc: add "API/User Documentation, Documentation Structure, and other Resources"

This is logically following the About section.

Author: phip1611

uefi/README.md

@@ -33,23 +33,6 @@ This crate's features are described in [`src/lib.rs`].
 
 [`src/lib.rs`]: src/lib.rs
 
-## User Documentation
-
-<!-- KEEP IN SYNC WITH MAIN README -->
-
-For a quick start, please check out [the UEFI application template](template).
-
-The [uefi-rs book] contains a tutorial, how-tos, and overviews of some important
-UEFI concepts. Reference documentation for the various crates can be found on
-[docs.rs]:
-
-- [docs.rs/uefi](https://docs.rs/uefi)
-- [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
-- [docs.rs/uefi-raw](https://docs.rs/uefi-raw)
-
-[spec]: http://www.uefi.org/specifications
-[uefi-rs book]: https://rust-osdev.github.io/uefi-rs/HEAD
-
 ## MSRV
 
 The minimum supported Rust version is currently 1.70.

uefi/src/lib.rs

@@ -68,6 +68,19 @@
 //! The minimum supported Rust version is currently 1.70.
 //! Our policy is to support at least the past two stable releases.
 //!
+//! # API/User Documentation, Documentation Structure, and other Resources
+//!
+//! Down below, you find typical technical documentation of all types, modules,
+//! and functions exported by `uefi`.
+//!
+//! For a TL;DR quick start with an example on how to create your own EFI
+//! application, please check out [the UEFI application template][template]. The
+//! [Rust UEFI Book] is a more beginner-friendly tutorial with How-Tos, and
+//! overviews of some important UEFI concepts and the abstractions provided by
+//! this library.
+//!
+//! For more details of UEFI itself, see the latest [UEFI Specification][spec].
+//!
 //! # Crate organisation
 //!
 //! The top-level module contains some of the most used types and macros,
@@ -196,6 +209,7 @@
 //! [contributing]: https://github.com/rust-osdev/uefi-rs/blob/main/CONTRIBUTING.md
 //! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
 //! [spec]: https://uefi.org/specifications
+//! [template]: https://github.com/rust-osdev/uefi-rs/tree/main/template
 //! [unstable features]: https://doc.rust-lang.org/unstable-book/
 //! [rustc-uefi-std]: https://doc.rust-lang.org/nightly/rustc/platform-support/unknown-uefi.html
 //! [uefi-std-tr-issue]: https://github.com/rust-lang/rust/issues/100499