doc: Talk about Documentation Organization/Overview [doc: 5/N] #1293
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phip1611
changed the title
2 tasks
phip1611
changed the title
2 tasks
…Resources" This is logically following the About section.
Also added "UEFI Strings" subsection
phip1611
changed the title
phip1611
commented
Aug 21, 2024
| @@ -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.
I'm going to add a small replacement in README.md in the next PR. But I want to keep this PR small
phip1611
commented
Aug 21, 2024
| //! | ||
| //! 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.
We never talked about this here specifically, but I think it is important.
nicholasbishop
approved these changes
Aug 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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