Technical documentation- feedback needed

Tried to make it as simple as i could

https://codepen.io/jude-create/pen/wvWNQNB

2 Likes

Hello @jude-create !! the content of the documentation is so useful and well written.
In my opinion I thought maybe it would be better if the font size for the content categories could be smaller , or maybe put a margin so it’s not that close to the content itself.
image
Other wise, I enjoyed reading this documentation !

2 Likes

Thanks, really appreciate

1 Like

@jude-create It looks really nice although what @beesha said the navbar looks a little close to the content. Good work! Happy Coding! :smile:

2 Likes

thanks @beesha and @landon.h.lloyd really appreciate. i have made it better now

2 Likes

Your page looks good @jude-create. Some things to revisit;

  • The test script should be included, with all tests passing, when you submit your projects.
    • Your page passes 6/16 user stories. Click the red button to see which test(s) are failing and text to help you correct the issue.
  • 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.
  • Run your HTML code through the W3C validator.
    • There are HTML coding errors you should be aware of and address.
  • Codepen provides validators for HTML, CSS and JS. Click on the down arrow in the upper right of each section and then click on the respective ‘Analyze’ link.
    • The one for CSS is good. Use it and address the issue(s).
    • (The one for HTML misses things which is why I recommend W3C)
  • Do not use the <br> element to force line breaks or spacing. That’s what CSS is for.