Feedback on my Documentation page

Hey guys. So I just completed my Delphi documentation page for the 4th project of the RWD certification. I’d love to hear some feedback from you guys!
Thx in advance for all the feedback.


A front-end rookie

Its really well made mate!!

Just a few things:

  • The first heading on the page should be an h1 instead of an h5. The h2s are fine but the h4s need to change to h3s. Moral of the story, always start with h1 and don’t skip heading levels.
  • I think your top menu that shows when the browser is narrow needs some work. I’m getting a vertical scroll bar for the menu itself.
  • If you use ‘em’ for your break point then the menu will shift to the top not only for narrower widths but also bigger text sizes.

Very well done here!
It would be really nice if you wrap the <code> tag inside a wrapper and give it a different background and text color to make it looks a lot easier to read and understand…
Overall though, Great Job!

Ok thanks, I’ll try that!

Page looks good @Ma3_str0. Something to revisit;

  • Don’t use <br> to force line breaks. Nest multi-line <code> snippets in <pre> </pre> tags in HTML to preserve whitespace and line breaks. Or you could do
code {
  white-space: pre;

in CSS and skip the <pre> tag in HTML.

1 Like