-
Notifications
You must be signed in to change notification settings - Fork 163
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Expand crate-level documentation #32
Comments
Note that this should be sequenced after #33. Particular care should be taken to discuss what exactly the safety considerations are around the unsafe constructors. |
Are there any nice to read examples or discussions of people using |
@burdges what do you mean by a table? To get a good sense of what people are using the crate for I'd recommend looking at https://crates.io/crates/memmap/reverse_dependencies. |
The root of a crate's documentation is the first thing a prospective user sees, and should provide an introduction to both the concepts the library deals with as well as quick examples of common usage patterns. See https://github.com/jonathandturner/rfcs/blob/b4ff67a2406651372c72fe7af856c3af62846e67/text/0000-api-doc-frontpage-styleguide.md for the kinds of things the crate root docs should discuss.
The text was updated successfully, but these errors were encountered: