Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork175
doc: Talk about Documentation Organization/Overview [doc: 5/N]#1293
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
…Resources"This is logically following the About section.
Also added "UEFI Strings" subsection
| @@ -33,23 +33,6 @@ This crate's features are described in [`src/lib.rs`]. | |||
| [`src/lib.rs`]: src/lib.rs | |||
| ## User Documentation | |||
There was a problem hiding this comment.
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
| //! | ||
| //! The top-level module contains some of the most used types and macros, | ||
| //! including the [`Handle`] and [`Result`] types, the [`CStr16`] and | ||
| //! [`CString16`] types for working with UCS-2 strings, and the [`entry`] and | ||
| //! [`guid`] macros. | ||
| //! | ||
| //! ## UEFI Strings |
There was a problem hiding this comment.
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.
93e864eUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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