Re: Transition Docs to Inline

2024-01-10 Thread Moshe Dicker
I should not that I'm only being critical to improve. The docs are well written, it's just disorganized. I mean no disrespect, we stand on the shoulders of giant, but that doesn't mean we should stop trying to improve. On Wednesday, January 10, 2024 at 11:57:40 PM UTC-5 Mariusz Felisiak wrote: >

Re: Transition Docs to Inline

2024-01-10 Thread Mariusz Felisiak
Agreed with Tim. > *I'll argue that right now we don't have documentation. We just have a mix of docs and reference, resulting in a convoluted manual that doesn't fit either need.* This is a really unfair opinion (not the only one in your comment). Hundreds of folks have put a lot of effort in

Re: Transition Docs to Inline

2024-01-10 Thread dickermo...@gmail.com
I'll argue that right now we don't have documentation. We just have a mix of docs and reference, resulting in a convoluted manual that doesn't fit either need. Django isn't some fly-by-night framework whose documentation will devolve if we move the technical reference and documentation into sepa

Re: Transition Docs to Inline

2024-01-10 Thread Tim Graham
I don't think moving docs inline is a good idea. Quoting Aymeric from 2013 regarding django.contrib.admindocs [1] summarizes my feelings: """ 1) It's called the "documentation generator", but it only operates on docstrings. This promotes the idea that docstrings are appropriate documentation, w