question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Suggestion: Wider context for code in RWD Beta

See original GitHub issue

In RWB, the placement of the instructions interrupts the code and makes indentation unclear, especially for a beginner that may not know what to look for yet.

I noticed several instances where putting longer, uninterrupted part of the code in the highlighted editor might help with clarity.

Examples

Step 21: change the error message or expand the highlighted code. (Error message when h3 is in the wrong location: “There should be an h3 element right above the second section element’s closing tag.”)

Step 23: include figure in highlighted editor to match the instructions (“A figure caption (figcaption) element is used to add a caption to describe the image contained withing the figure element.”) and to show the placement of figcaption within figure.

Step 50: include fieldset in highlighted editor to match the instructions (“The legend element acts as a caption for the content in the fieldset element.”) and to show the placement of legend within fieldset.

Proposed solutions

  • Expand the code on case-per-case basis.
  • Permanently move the instructions box on top of the code editor. (I think that would make everything clearer and more accessible with well defined sections on the page, but I imagine it would be harder to implement now.)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
WaterBloomcommented, Jul 10, 2022

@ahmadabdolsaheb Hello, sorry for the late reply.

I am interested in knowing more about this: " it takes me a while to find and re-focus on the editor." Are you having difficulty locating the instructions? do also look around for the tests and the submit button? More context is appreciated.

After seeing this notification, I opened the curriculum on a random step to see if I could provide you with more information. I mostly forgot how the page was structured and my eyes just ran across the page in no specific order. “Check your code” was the first text I read, as it draws the most attention, and then “index.html”.

An easy fix would be to scroll the editor so the instructions are always almost at the top of the “page”. That way the eyes know where to go on each challenge. (right now it scrolls to the center)

I believe that would be very helpful!

(I think it would also be nice if the navigation breadcrumbs were more subtle, and if the buttons like “index.html”, “style.csss” and “preview” looked more like toggle buttons – now they remind me of tabs but disconnected from their sections, and they also draw more attention than is perhaps needed?)

Thank you for checking in on this!

1reaction
moT01commented, Jan 20, 2022

I’m fine with changing the three lessons mentioned here, but we could maybe use a discussion on how those regions should be. There’s probably going to be many steps where the editable region could be bigger or smaller or different. Maybe we need some hard rules on how to apply them. Something like - for HTML steps, include the parent element in the region. For CSS steps, include the whole selector.

There may be instances where rules like that don’t work out so well. Like for the first steps of the Cat Photo project, we may want to be more specific about where to add code - and on later steps or projects, more vague. So I don’t know.

Read more comments on GitHub >

github_iconTop Results From Across the Web

RWD Beta: Subjective changes and unclear directions #44845
RWD Beta: Subjective changes and unclear directions #44845 ... Step 3: Suggest changing could be to is fix: typos in the new RDW...
Read more >
Using media queries - CSS: Cascading Style Sheets | MDN
Media types define the broad category of device for which the media query ... Level 4 adds a range context for writing such...
Read more >
Code Review Guidelines - GitLab Docs
This guide contains advice and best practices for performing code review, and having your code reviewed. All merge requests for GitLab CE and...
Read more >
CSS Backgrounds and Borders Module Level 3 - W3C
This property sets the background color of an element. The color is drawn behind any background images. Example: h1 { background-color: #F00 } ......
Read more >
Release Notes for Beta Channel - Microsoft Learn
Version 2212: December 02. Version 2212 (Build 15928.20000). Feature updates. Access. Enable the ability to code sign your Microsoft Access database and VBA ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found