se-edu / guides

Style guides and tutorials for SE student projects
MIT License
5 stars 20 forks source link

[AB3: Tracing Code] Update tip boxes #24

Closed ruth-lim closed 5 days ago

ruth-lim commented 2 weeks ago

Current

Picture 1

Problem

Inconsistency in the alert/tip boxes. This can make readers confused or feel that the content is very messy.

Proposed

To standardise all tips (with the light bulbs) to be placed in the boxes. Certain tips can also be classified as “Note" or " Info" and be put in a different color box to avoid overwhelming the reader with too many tip boxes.

Note: This can be improved across all 3 tutorials.

damithc commented 1 week ago

@ruth-lim Tip box formatting has changed since we moved the tutorial out of AB3. Can you take a look at https://se-education.org/guides/tutorials/ab3TracingCode.html and see if this issue is still applicable?

ruth-lim commented 5 days ago

Closing this issue as it is no longer applicable after migrating out of AB3.