Feedback ----> Technical Documentation Project

Code Feedback
1

Hello World

I just finished my Technical Documentation project and need some feedback on it.

Cheers

:+1: :+1: :+1:

2

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

  • Codepen provides the boilerplate for you. It only expects the code you’d put within the body element in HTML. (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.
    • The link to the font goes in the box labeled ‘Stuff for <head>’

I don’t normally comment on someone’s design choices. You can either implement these, or ignore them.

  • The CSS code samples in your document are basically on one line. Yet, when you write CSS you do it over multi-line. Most developers are used to that and that’s how they read it. If this is indeed a technical doc then it would be better to present snippets the way the user would expect to read it.
    • You can accomplish this by nesting multi-line <code> snippets in <pre> </pre> tags in HTML to preserve whitespace and line breaks.
      Or skip the <pre> tag and do the following in CSS;
code {
  white-space: pre;
}
  • Color choices are hard to read. Someone with sight problems are going to have a hard time seeing the red font on grey background. Likewise, green on green in your nav doesn’t have as much contrast as it should.
1 Like