News for hackers. Stuff that matters.
Re:SQLAlchemy 2.0 Released by mixmastamyk on Thursday January 26, 2023 @08:59PM (#34541555)
Great tool. I think this is why folks have trouble finding the docs:

Whole entire site is docs everywhere, including home page. Links to "docs" are tiny on the home page. Main menu calls them "library" instead of docs, why?

Majority of the stuff is focused on migration rather than new users. These two should be separated into separate tracks immediately. There is an attempt, but it gets lost somehow.

Also the release page linked here and "what's new in 2.0" go straight into the deep end, "inside baseball" style. These kind of pages should be very light. Tons of history-I'm personally not interested when trying to get something done. Unsolicited advice, move that into another blog post. ;-)

Re:SQLAlchemy 2.0 Released by zzzeek on Thursday January 26, 2023 @09:41PM (#34541812)
The link I posted here is the blog post. That's why it's historical and chatty, it's the blog post.
Re:SQLAlchemy 2.0 Released by inquirer39243 on Thursday January 26, 2023 @09:52PM (#34541890)
Love your tools!

I think you should consider changing "library" to "documentation" - for whatever reason I also struggled to discover "library" actually meant docs - but only after I also clicked on a specific version.

I think the best UI/UX for this is something like django's [0], where "documentation" brings you straight to the latest version's documentation.

[0] https://www.djangoproject.com/

Re:SQLAlchemy 2.0 Released by zzzeek on Friday January 27, 2023 @10:49AM (#34547340)
> I think you should consider changing "library" to "documentation" - for whatever reason I also struggled to discover "library" actually meant docs - but only after I also clicked on a specific version.

you got it, look now

> I think the best UI/UX for this is something like django's [0], where "documentation" brings you straight to the latest version's documentation.

the design of our main docs index page was taken completely from how Django does it (e.g. how they have "paragraphs of links" at https://docs.djangoproject.com/en/4.1/)

Re:SQLAlchemy 2.0 Released by inquirer39243 on Friday January 27, 2023 @08:24PM (#34554119)
Oh yeah I love it!

I don't know why but it's just way more intuitive this way for me at least, thanks!

Re:SQLAlchemy 2.0 Released by zzzeek on Friday January 27, 2023 @10:46AM (#34547318)
> Whole entire site is docs everywhere, including home page. Links to "docs" are tiny on the home page.

you got it, look now. If you can't find the docs now, I dont know what to say.

> Main menu calls them "library" instead of docs, why?

A library is where you'd go to learn...but I guess, because the product is a "library", that's why it's not obvious? The term is gone from the nav etc. the sub-page is still called "library" but nobody needs to go there.