minor docs: mention `#![doc = include_str!("../README.md")]`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Location (URL)
https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html
Summary
https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html reads: "Cargo currently does not understand standalone Markdown files"
Suggest to mention that in src/lib.rs we can have (for example) #![doc = include_str!("../README.md")]. This may be mentioned elsewhere, but I believe it's worth mentioning here, too.
I'm willing to provide a pull request. Does that sound OK?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the rustdoc page at https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html and locate its source in the repository. Add a brief mention that src/lib.rs can use the shown doc = include_str!("../README.md") form, and verify that the page accurately explains this workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 56/100