Skip to main content

Rust Documentation Project

·1 min

Sometimes, you use a Rust crate and you notice that the documentation is sorely lacking. This happened to me as I was working with Oso. It’s quite an interesting crate — deserving of a blog post in an of itself. But the documentation for it, not so great.

I went on to to find some crates that are both popular (as measured by having many recent downloads) and subpar documentation (as measured by myself finding undocumented items or missing code examples).

Here is some crates that I have identified where I could potentially make some improvements:

I think it is always valuable to give back to the community by finding areas where you can contribute something, even if it is not documentation. I’ll keep posting on how this progresses.