Technical Documentation Page Feedback - cfraticelli


Below is my technical documentation page. Any feedback would be appreciated!

Hi @cfraticelli !

I think your page looks good.

You do have a couple errors in your html.
I would run your code through the HTML validator

Most of the errors have to deal with the incorrect br tag
You wrote this:

Keep up the good work!

1 Like

Thank you again for looking into this! I’ve gone through and changed the br tags to the correct be tags.

  • Do not use the <br> element to force line breaks or spacing. That’s what CSS is for.

Research into how to put code snippets into a document.
In programming circles, you’ll see a lot of conversation about (technical) documentation, in reference to explaining an API, library, project contribution, etc. Reading and writing good documentation is an important skill and doing this project about a code related subject gives you a good reason to go do some research about the tools you are learning to use.

1 Like