iommirocks / iommi

Your first pick for a django power cord
http://iommi.rocks
BSD 3-Clause "New" or "Revised" License
784 stars 51 forks source link

Getting Started Documentation issues. #386

Closed MickeyM79 closed 1 month ago

MickeyM79 commented 1 year ago

I'm kicking the tires(picks) of iommi for the first time. In doing so, I'm following the Getting Started section and ran into some things that could trip up someone not familiar with Django. I'll outline the issues here and make a pull request later after I finish going through the documentation, unless I am just doing something wrong.

boxed commented 1 year ago

hmm. you're very right. The tutorial has that kind of note at the top: https://docs.iommi.rocks/en/latest/tutorial.html

MickeyM79 commented 1 year ago

Does it make more sense to just copy the model info to the getting started section, or just point the getting started section to the tutorial? I haven't read through the tutorial yet, so I'm not sure what all is in it. Either way.. I don't care to update and send a PR once it's determined how it should look.

boxed commented 1 year ago

yea... the tutorial is written way more recent than the Getting Started guide, so that probably shows :P

Please keep the feedback coming!

boxed commented 1 month ago

I have made some changes to the getting started page to improve this.