search

backdrop / backdrop-issues

Issue tracker for Backdrop core.
144 stars 39 forks source link

[UX] - Add examples to help text for layout paths #6698

Open stpaultim opened 2 weeks ago

stpaultim commented 2 weeks ago

Description of the bug

In working on some layout related issues for the 1.29 release, I am reminded on how difficult to understand the layout system can be. Specifically, I struggled a bit to figure out how to find the path to use if I wanted to create a layout for a 403 error page. https://github.com/backdrop/backdrop-issues/issues/6016

image

I'm not sure how I would figured out this path. It made we wonder if our examples might expand beyond placeholder paths.

Currently, given the examples, one might believe that the path must contain a placeholder.

Expected behavior

What if we provided some extra examples (something like this):

image

PR provided is a draft to generate some discussion about whether or not this is a good idea and if so, what examples we might add.

stpaultim commented 1 week ago

Talked about this in Design/UX meeting today. @jenlampton had some good suggestions.

1) Add a link to some documentation page that can provide much more detail. 2) Including system/404 - good idea 3) Wan't sure that "custompath" was necessary

Can anyone think of any other good examples of paths that would be helpful to include.

Can someone help find or create the best documentation page for these concepts? I have not looked yet.

stpaultim commented 1 week ago

I did a little poking around in the Layouts section of documentation. Right now, I'm thinking that maybe we need a new "Deep Dive" page here for "Layouts and Paths"?

image

I would definitely appreciate some feedback on this or alternative ideas.