search

loco-rs / loco

🚂 🦀 The one-person framework for Rust for side-projects and startups
https://loco.rs
Apache License 2.0
5.56k stars 240 forks source link

Improve Documentation Site UX #768

Open patrikzudel opened 2 months ago

patrikzudel commented 2 months ago

Description

I've found Loco just yesterday, today I've noticed that the whole Documentation page has been redone - I am afraid that it is a downgrade in regards to UX. (The design is nice though!)

Due to the scale of the project, users will jump from page to page often. This is exactly where the problem lies, to navigate to a different page in the new docs, you first have to scroll up to the top of the page. This feels unnecessary when working on a 16:9 display as there is quite a bit of whitespace.

Suggestion

When there is sufficient space, the navigation for docs should be on the left or right side. Only the document content should respond to scrolling down so the navigation would always be accessible.

By navigation I mean the Red navigation here - image

ammoti commented 2 months ago

Hi, First of all I want to congratulate all loco.rs team for the new UI. I did not want to open new issue for this, in dark mode blog articles commands not display very well, I hope you will fix it next update.

Screenshot 2024-09-20 at 05 30 48
Gizzard2790 commented 2 months ago

I think reverting back to using docs.rs as a default is better. it will remove a lot of burden from maintainers since comments above functions will be included by default in docs.rs. not to mention it will automatically test examples to make sure that they are working properly to avoid any inconstancies rust analyzer integration ...