DEV Community

Cover image for Projects with Great Documentation
Nick Taylor
Nick Taylor

Posted on • Updated on • Originally published at iamdeveloper.com

Projects with Great Documentation

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)

Collapse
 
kantord profile image
Daniel Kantor
Collapse
 
nickytonline profile image
Nick Taylor

Awesome!

Hackerman from Kung Fury putting on a Nintendo Power glove

Collapse
 
king11 profile image
Lakshya Singh

Python is ❤️

Collapse
 
matteobruni profile image
Matteo Bruni

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.

github.com/matteobruni/tsparticles

I’m updating that right now and if someone has some good ideas is welcome to contribute

Collapse
 
nickytonline profile image
Nick Taylor

Noice!

Noice!

Collapse
 
stereoplegic profile image
Mike Bybee • Edited

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).

Collapse
 
nickytonline profile image
Nick Taylor

Yeah!

A T-Rex saying Yeah!

Collapse
 
fultonbrowne profile image
Fulton Browne

not sure if it counts. But the arch wiki is the ultimate source of linux knowledge wiki.archlinux.org/

Collapse
 
nickytonline profile image
Nick Taylor

Bobby Moynahan character from SNL saying awesome!

Collapse
 
yjdoc2 profile image
YJDoc2

Rust has one of the best language documentation I have come across :
doc.rust-lang.org/std/index.html
doc.rust-lang.org/book/
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

Collapse
 
steelwolf180 profile image
Max Ong Zong Bao

Django

Collapse
 
nickytonline profile image
Nick Taylor

Pam from The Office saying Nice!

Collapse
 
dwjohnston profile image
David Johnston

The MDN documentation. :)

Collapse
 
nickytonline profile image
Nick Taylor

It's True - Dwight Shrute

Collapse
 
yaythomas profile image
yaythomas

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 😆

Collapse
 
nickytonline profile image
Nick Taylor

The docs look great! 👏🏻

Croc mascot nodding

Collapse
 
yaythomas profile image
yaythomas

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 😎

Collapse
 
reobin profile image
Robin Gagnon

Stripe docs have to make the list

Collapse
 
reobin profile image
Robin Gagnon

Also worked recently with stenciljs and enjoyed reading through the docs

Collapse
 
nickytonline profile image
Nick Taylor

Nice!

A kangaroo playing an electric guitar

Collapse
 
rafi993 profile image
Rafi
Collapse
 
nickytonline profile image
Nick Taylor

Now you’re making us blush. 😊

Actor Zach Galifianakis giving a thumbs up in a convertible car

Collapse
 
nickytonline profile image
Nick Taylor

Now docs.Forem.com 😎

Collapse
 
raae profile image
Benedicte Raae

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.

Collapse
 
vtrpldn profile image
Vitor Paladini • Edited

threejs.org/docs is very good!

Collapse
 
scroung720 profile image
scroung720

THREE JS

Collapse
 
nickytonline profile image
Nick Taylor

Nice!

Nice

Collapse
 
amrutaranade profile image
Amruta Ranade • Edited

cockroachlabs.com/docs ❤️

We are accepting Hacktoberfest contributions: github.com/cockroachdb/docs/issues...

Collapse
 
nickytonline profile image
Nick Taylor

Kylo Ren on Undercover Boss giving a thumbs up

Collapse
 
bobbyiliev profile image
Bobby Iliev
Collapse
 
nickytonline profile image
Nick Taylor

Jean-Luc Picard from Star Trek TNG saying Well done!

Collapse
 
perpetual_education profile image
perpetual . education

+1 for Vue as a great set of docs.