I'm looking to compile a list of projects with great documentation so as to provide examples to contributors and maintainers for Hacktoberfest.
Some projects with great documentation that come to mind are React and Vue.
What's a project that you know of that has great documentation?
Top comments (64)
Python is ❤️
tsParticles uses typedoc to create basic documentation, I created also a customized theme with markdown support to add custom pages with more details, readme are also a good point to start.
I’m updating that right now and if someone has some good ideas is welcome to contribute
React Spring (though I wish the library itself would hurry up with v9 and especially Reanimated support).
The "preliminary docs as issues" approach of Jotai (under the org formerly known as React Spring) is beautiful, and @dai_shi is a shining example of maintainer involvement in them (and all Jotai issues).
not sure if it counts. But the arch wiki is the ultimate source of linux knowledge wiki.archlinux.org/
Rust has one of the best language documentation I have come across :
Rust-wasm has really great 'getting started' docs : rustwasm.github.io/docs/book/intro...
Rustling course has a nice readme : github.com/rust-lang/rustlings
The MDN documentation. :)
great inspirational tech docs sites listed here!
if you're looking for an example of a smaller open-source project: pypyr
the docs are generated with the awesome Hugo static site generator, and the theme itself is also open-source, so if you like, you can make your own.
warning: I might be a bit predisposed to like this one, because I made it 😆
The docs look great! 👏🏻
thank you so much! 🙌
I tried hard to make something functional but also have it look a bit more designed (without going overboard).
So the nod from the cool alligator makes it all worth it 😎
Stripe docs have to make the list
Also worked recently with stenciljs and enjoyed reading through the docs
Now you’re making us blush. 😊
Now docs.Forem.com 😎
I think Vue is the best I have come across, I started reading it like a book. This was years ago... But also I really enjoy using Material-UI and part of that is because their docs are good.
threejs.org/docs is very good!
We are accepting Hacktoberfest contributions: github.com/cockroachdb/docs/issues...
+1 for Vue as a great set of docs.