loading...
Cover image for Projects with Great Documentation

Projects with Great Documentation

nickytonline profile image Nick Taylor (he/him) ・1 min read

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?

Discussion

pic
Editor guide
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
Collapse
kantord profile image
Collapse
nickytonline profile image
Collapse
king11 profile image
Lakshya Singh

Python is ❤️

Collapse
stereoplegic profile image
Mike Bybee

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
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
Collapse
steelwolf180 profile image
Collapse
nickytonline profile image
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
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
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 (he/him) Author

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
rafi993 profile image
Collapse
nickytonline profile image
Nick Taylor (he/him) Author

Now you’re making us blush. 😊

Actor Zach Galifianakis giving a thumbs up in a convertible car

Collapse
vtrpldn profile image
Collapse
scroung720 profile image
Collapse
nickytonline profile image
Collapse
amrutaranade profile image
Amruta Ranade

cockroachlabs.com/docs ❤️

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

Collapse
nickytonline profile image
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
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
Collapse
nickytonline profile image
Collapse
simerca profile image
Ayrton

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

Collapse
nickytonline profile image
Collapse
ferueda profile image
Felipe Rueda

React Query and React Table docs are amazing

Collapse
nickytonline profile image
Collapse
perpetual_education profile image
perpetual . education

+1 for Vue as a great set of docs.

Collapse
bimlas profile image
Collapse
nickytonline profile image
Nick Taylor (he/him) Author

That's awesome! 🔥

Yes, that's awesome!

Collapse
lucifer___13 profile image
Collapse
king11 profile image
Lakshya Singh

Best docs ever vuejs for sure

Collapse
yujiri8 profile image
Ryan Westlund

Go and PostgreSQL come to mind. Maybe also Crystal.

Collapse
nickytonline profile image
Collapse
banzyme2 profile image
EN_DEE_SA

Vagrant

Collapse
nickytonline profile image
Collapse
fkhadra profile image
Fadi Khadra

react-toastify is not that bad

Collapse
nickytonline profile image
Collapse
psmigielski profile image
Collapse
nickytonline profile image
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
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
Collapse
tchenu profile image
Thibeault Chenu

Laravel has one of the best documentations I find 👍🏻

laravel.com/docs

Collapse
nickytonline profile image
Collapse
yzhernand profile image
Collapse
nickytonline profile image
Collapse
alaindet profile image
Collapse
nickytonline profile image
Collapse
jchlu profile image
Johnny C-L

RedwoodJS has amazing docs

Collapse
madhur_malpani profile image
Madhur Malpani

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

Collapse
fredericbonnet profile image
Frédéric Bonnet

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

docsify.js.org/

Collapse
dufcrule profile image
Ian Cowley

Hashicorp has great docs: learn.hashicorp.com/

Collapse
hozefaj profile image
Hozefa

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