DEV Community

Cover image for Projects with Great Documentation

Projects with Great Documentation

Nick Taylor on September 28, 2020

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?

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
 
steelwolf180 profile image
Max Ong Zong Bao •

Django

Collapse
 
nickytonline profile image
Nick Taylor •

Pam from The Office saying Nice!

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
 
dwjohnston profile image
David Johnston •

The MDN documentation. :)

Collapse
 
nickytonline profile image
Nick Taylor •

It's True - Dwight Shrute

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
 
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
 
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
 
raae profile image
Benedicte (Queen) 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
 
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
 
vtrpldn profile image
Vitor Paladini • • Edited

threejs.org/docs is very good!

Collapse
 
nickytonline profile image
Nick Taylor •

Nice!

Nice

Collapse
 
scroung720 profile image
scroung720 •

THREE JS

Collapse
 
simerca profile image
Ayrton •

Hey !
Strapi has a good doc's
strapi.io/documentation/v3.x/getti...

Collapse
 
nickytonline profile image
Nick Taylor •

Lego astronaut saying awesome!

Collapse
 
perpetual_education profile image
perpetual . education •

+1 for Vue as a great set of docs.

Collapse
 
maximization profile image
Maxim Orlov •

The docs of pg-promise are very detailed. I also like json-server because it's easy to follow.

@dayhaysoos ' project use-shopping-cart has a Q&A type approach which is very helpful.

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

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

Collapse
 
bimlas profile image
bimlas •
Collapse
 
nickytonline profile image
Nick Taylor •

That's awesome! 🔥

Yes, that's awesome!

Collapse
 
yzhernand profile image
Yozen Hernandez •
Collapse
 
nickytonline profile image
Nick Taylor •

Hot Rod saying Cool beans!

Collapse
 
lucifer___13 profile image
Rajesh Jaga •
Collapse
 
king11 profile image
Lakshya Singh •

Best docs ever vuejs for sure

Collapse
 
psmigielski profile image
Paweł Śmigielski •
Collapse
 
nickytonline profile image
Nick Taylor •

TV personality saying Frickin' awesome!

Collapse
 
nickytonline profile image
Nick Taylor •

Actor Leonardo DiCaprio as Gatsby doing a cheers

Collapse
 
shubhamzanwar profile image
Shubham Zanwar •

Check out vue-nodegui. It's a cross platform desktop app library with vue.

docs at: vue.nodegui.org
repo link: github.com/nodegui/vue-nodegui

Collapse
 
nickytonline profile image
Nick Taylor •

Loki holding KFC

Collapse
 
bias profile image
Tobias Nickel •

php, on php.net, you not only find the documentation, but also very useful examples, that help to understand the functionality

Collapse
 
nickytonline profile image
Nick Taylor •

Kirk and Bones nodding to each other in Star Trek

Collapse
 
fkhadra profile image
Fadi Khadra •

react-toastify is not that bad

Collapse
 
nickytonline profile image
Nick Taylor •

Toast jumping out of a toastser

Collapse
 
banzyme2 profile image
ENDEESA •

Vagrant

Collapse
 
nickytonline profile image
Nick Taylor •

Actor Leonardo DiCaprio as Gatsby doing a cheers

Collapse
 
nickytonline profile image
Nick Taylor •

Amy Poehler being cool

Collapse
 
madhur_malpani profile image
Madhur Malpani •

Fastapi (fastapi.tiangolo.com/) : micro back end framework written in python

Collapse
 
hozefaj profile image
Hozefa •

next.js has one of the best documentation imo. Very concise, straightforward and easy to comprehend.

Collapse
 
fredericbonnet profile image
Frédéric Bonnet •

Docsify, which as a matter of fact is a documentation site generator.

docsify.js.org/

Collapse
 
jchlu profile image
Johnny C-L •

RedwoodJS has amazing docs

Collapse
 
dufcrule profile image
Ian Cowley •

Hashicorp has great docs: learn.hashicorp.com/

Collapse
 
nickytonline profile image
Nick Taylor •

Stephen Colbert saying Awesome Sauce

Collapse
 
alaindet profile image
Alain D'Ettorre •
Collapse
 
nickytonline profile image
Nick Taylor •

Dog from GoT with friend chicken