Skip to content

doc: massive overhaul of documentation #1264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed

doc: massive overhaul of documentation #1264

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
79c048a
uefi: remove documentation about already removed feature
phip1611 Jul 28, 2024
676c585
doc: unified new TL;DR/description entry
phip1611 Jul 30, 2024
27ec946
doc: add "About this Document"
phip1611 Jul 30, 2024
d85b4c9
doc: move background info to lib.rs
phip1611 Jul 30, 2024
9f9e5ca
doc: streamline sections Contributing, MSRV, and License
phip1611 Jul 30, 2024
505e70f
doc: add "About" section
phip1611 Jul 30, 2024
e46e74a
doc: extend About section with Example Use Cases
phip1611 Jul 30, 2024
02bc2cf
doc: add Supported Architectures
phip1611 Jul 30, 2024
52954f4
doc: add "Comparison to other Projects in the Ecosystem"
phip1611 Jul 30, 2024
837fe5c
doc: add "API/User Documentation, Documentation Structure, and other …
phip1611 Jul 30, 2024
b9829d7
doc: Crate organization -> Library Structure & Tips
phip1611 Jul 30, 2024
e0fde84
doc: reorder links alphabetically in lib.rs
phip1611 Jul 30, 2024
5c9343f
doc: final streamlining of README files
phip1611 Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# uefi-rs

Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].

[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)

## TL;DR
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think we should drop the tl;dr header here since the section is just one sentence. Have this content come directly after the "Rusty wrapper for the Unified Extensible Firmware Interface." sentence.


Develop Rust software that leverages **safe**, **convenient**, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: For clarity I would add a few words at the start of the sentence like "This crate makes it easy to develop Rust software [..].". Makes it clearer that we aren't necessarily the ones making the safe/convenient/performant software, but rather we're helping users of the crate do that.

**performant** abstractions for [UEFI] functionality.

## Description

[UEFI] started as the successor firmware to the BIOS in x86 space and developed
Expand Down Expand Up @@ -136,3 +143,5 @@ This license allows you to use the crate in proprietary programs, but any
modifications to the files must be open-sourced.

The full text of the license is available in the [license file](LICENSE).

[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface
5 changes: 4 additions & 1 deletion uefi/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
name = "uefi"
version = "0.29.0"
readme = "README.md"
description = "Safe and easy-to-use wrapper for building UEFI apps."
description = """
Develop Rust software that leverages safe, convenient, and performant
abstractions for UEFI functionality.
"""

authors.workspace = true
categories.workspace = true
Expand Down
8 changes: 7 additions & 1 deletion uefi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# uefi-rs
# `uefi`

Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].

[![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi)
[![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi)
![License](https://img.shields.io/github/license/rust-osdev/uefi-rs)
![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg)
![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs)

## TL;DR

Develop Rust software that leverages **safe**, **convenient**, and
**performant** abstractions for [UEFI] functionality.

For an introduction to the `uefi-rs` project and documentation, please refer to
our main [README].
Expand Down
5 changes: 5 additions & 0 deletions uefi/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
//! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI].
//!
//! # TL;DR
//!
//! Develop Rust software that leverages **safe**, **convenient**, and
//! **performant** abstractions for [UEFI] functionality.
//!
//! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some
//! important UEFI concepts. For more details of UEFI, see the latest [UEFI
//! Specification][spec].
Expand Down