Ask HN: What is example of good documentation in your opinion?

Re:Ask HN: What is example of good documentation in your opi... by leetrout on Sunday November 20, 2022 @12:21PM (#33682987)

Django is one of the gold standards for me.

Great examples. Clearly noting what versions things changed. Ability to switch versions at the click of a button.

https://docs.djangoproject.com/en/4.1/

[ Parent | on HN ]

Re:Ask HN: What is example of good documentation in your opi... by fakedang on Sunday November 20, 2022 @02:52PM (#33684595)

Django docs have much better examples than many of its "tutorials" out there.

[ Parent | on HN ]

Re:Ask HN: What is example of good documentation in your opi... by boxed on Monday November 21, 2022 @02:25PM (#33696729)

I help out on the Unofficial Django Discord a lot. I have to constantly tell people to go do the tutorial on djangoproject.com instead of some rando youtubers totally broken tutorial. It's crazy how many incompetent youtube tutorials there are just for django!

[ Parent | on HN ]

Re:Ask HN: What is example of good documentation in your opi... by jfornear on Sunday November 20, 2022 @10:29PM (#33688382)

I love Django. Inspired me to start an open source project for gaps in their docs like setting up a local development environment, using React for the frontend, adding Google Analytics, deploying to Heroku/AWS, etc.

https://learndjangoreact.com/tutorial

https://learndjangoreact.com/docs/add-google-analytics

[ Parent | on HN ]