Move docs on Main Types to the top #97
Merged
Conversation
This file contains 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
Signed-off-by: Nico Burns <nico@nicoburns.com>
nicoburns
force-pushed
the
move-type-docs-up
branch
from
aaef2e2 to
363819b
Compare
waywardmonkeys
approved these changes
Dec 16, 2024
Signed-off-by: Nico Burns <nico@nicoburns.com>
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Moves the "Main types" section above the "Scope and goals" section in the lib.rs docs.
Justification: I think the documentation on "what are the main types in this crate" / "how do I use this crate" ought to be front and center. Whereas the "background" on scope and goal is more secondary. The "Main Types" section is also quite a bit shorter than the "Scope and goals" section, so it means both fit "above the fold".
More concretely, I was reading the docs and trying to work out which type(s) could be considered the primary/default color representation(s). And it took me quite a bit of time to find it even though there was already a section explaining it.