Feedback on Tech Documentation Page

Code Feedback
1

A Pen by Codrin Bulgariu (codepen.io)

2

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

  • Keep the test script when forking the pen (<script src="https://cdn.freecodecamp.org/testable-projects-fcc/v1/bundle.js"></script>)
    • The test script should be included, with all tests passing, when you submit your projects.
  • Run your HTML code through the W3C validator.
    • There are HTML coding errors you should be aware of and address. (All the entities are not syntactically correct)
    • Since copy/paste from codepen you can ignore the first warning and first two errors.
  • Do not use the <br> element to force line breaks or spacing. That’s what CSS is for.
    • Reference MDN Docs
    • You can nest multi-line <code> snippets in <pre> </pre> tags in HTML to preserve whitespace and line breaks.
      Or skip the pre element and do the following in CSS;
code {
  white-space: pre-line;
}
  • Revisit whether you actually need all those vendor prefixes
3

This looks really nice. The one thing that I think needs work are the CSS code examples. Sitepoint has some really good tips for marking up code examples.

4

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