Skip to content

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Aug 6, 2024

This is split-out 5/N from #1264 to improve reviewability.

This adds a section that talks about our Documentation Organization/Overview

Steps to Un-draft

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

@phip1611 phip1611 changed the title doc: move misc stuff from README to lib.rs [doc: 5/5] doc: move misc stuff from README to lib.rs [doc: 5/N] Aug 6, 2024
@phip1611 phip1611 changed the title doc: move misc stuff from README to lib.rs [doc: 5/N] doc: TODO [doc: 5/N] Aug 6, 2024
…Resources"

This is logically following the About section.
@phip1611 phip1611 marked this pull request as ready for review August 21, 2024 11:58
@phip1611 phip1611 changed the title doc: TODO [doc: 5/N] doc: Talk about Documentation Organization/Overview [doc: 5/N] Aug 21, 2024

[`src/lib.rs`]: src/lib.rs

## User Documentation
Copy link
Member Author

@phip1611 phip1611 Aug 21, 2024

Choose a reason for hiding this comment

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

I'm going to add a small replacement in README.md in the next PR. But I want to keep this PR small

//! [`CString16`] types for working with UCS-2 strings, and the [`entry`] and
//! [`guid`] macros.
//!
//! ## UEFI Strings
Copy link
Member Author

Choose a reason for hiding this comment

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

We never talked about this here specifically, but I think it is important.

@nicholasbishop nicholasbishop added this pull request to the merge queue Aug 21, 2024
Merged via the queue into rust-osdev:main with commit 93e864e Aug 21, 2024
@phip1611 phip1611 deleted the doc6 branch May 1, 2025 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants