Technical Documentation Page - Finished

Code Feedback
1

Hello, I just finished my Technical Documentation Page and I would like to know what you think, any advice for future projects is well received :smiley:

2

Hello!
I hope your day is going well!

It looks very clean and professional!
One small thing is on a mobile device, the menu occludes the text.

I have attached a picture for a more clear representation:

Screenshot_20210810-193535_Chrome
Screenshot_20210810-193535_Chrome1080×2220 152 KB

Other than that, it looks beautiful!

3

Your page looks good @MauGJ. Some things to revisit;

  • Codepen provides the boilerplate for you. It only expects the code you’d put within the body element in the HTML editor. (No need to include the body tags). For anything you want to add to the <head> element click on the ‘Settings’ button, then HTML and add it into the ‘Stuff for <head>’ box.
    • For instance, links to fonts go in the box labeled ‘Stuff for <head>’
    • The FCC test script would not go into the head element. It will not work properly since it requires that the HTML code be loaded prior to. (codepen is forgiving which is why you don’t see an issue)
  • Run your HTML code through the W3C validator.
    • There are HTML syntax/coding errors you should be aware of and address.
  • Do not use the <br> element to force line breaks or spacing. That’s what CSS is for.
    • Reference MDN Docs
    • You can nest those code snippets in an HTML element to preserve whitespace and line breaks. I’ll leave it to you to research that.
      Or there’s a property: value; pair you can use in CSS to preserve whitespace and line breaks. Again, I’ll leave it to you to research.
  • As mentioned, on smaller screens the #main-doc is not taking the navbar into account
4

Hi, thanks for the compliments :smiley:
Thanks for letting me know about the menu, it’s already fixed.

5

Hello, thank you for taking the time to help me.
About your first point, I don’t know if it affects something that I do all my code in VS Code and not in Codepen, if it does not affect something, I will improve at that point.
Now about your second point, it will be very useful to execute my code and avoid errors for future projects, thanks.
About the third point, I will start to investigate, thank you for notifying me of my error
The navbar I think is in a better way.
And sorry if I did not understand any of your points well or you did not understand my answers, I am learning English, so to understand some things I have to use the translator.

6

This topic was automatically closed 182 days after the last reply. New replies are no longer allowed.