open-learning-exchange.github.io icon indicating copy to clipboard operation
open-learning-exchange.github.io copied to clipboard

Some steps show examples in embedded images while some don't.

Open axzhir opened this issue 1 year ago • 1 comments

Problem

Some steps given show images of examples while some steps don't.

Steps to reproduce the problem

N/A

Screenshots

Screenshot 2024-05-08 at 20 50 31

Proposed solution

I believe that for the steps, the examples should be shown a little after the description is written. This is so that the user who's reading can see what they need to do immediately, instead of having to open it in another tab. (This can also prevent the user from accidentally skipping the highlighted link to the examples).

This could also be prevented by making each image for each step have a link directing to another tab. Either solution would work fine.

axzhir avatar May 09 '24 00:05 axzhir

I'm with you on the idea of adding more images, but we've also got to be careful not to overwhelm the first steps with too much visual and instructional content. Our primary focus at the moment is to keep those initial steps concise and eliminate any unnecessary repetition.

In this particular case, after reviewing the screenshot carefully, I believe it's best to ditch both the image and the text alongside it. It does not see right because it's currently more about creating a new branch on github.com rather than focusing on the practical aspect of the previous step, which is all about Git command line action. Plus, right after the image, we dive straight into command line branch creation instructions anyway.

Please create a pull request to remove the image and texts to the left of it.

xyb994 avatar May 13 '24 17:05 xyb994

closing this as the branch creation confusion was addressed in #3290

xyb994 avatar Jun 04 '24 19:06 xyb994