Feedback on the documentation page project

Code Feedback
1

Hey guys i just finished working on the documentation page project

https://michicko.github.io/jsDocumentation/

I’d really like to hear your honest opinion and feedback on this project so i improve on it further.

Thanks.

2

Hey!

Looks very good and neat. As a user I would really like to have a look at this site. The explanation looks good and is also very clear. There are some things that can be tweaked to make it even finer, but this is not necessary for now.

Good luck with upgrading this website.

Greetings!

3

Thank you for the feedback, i appreciate you taking a look.

1 Like
4

Hey there,

great job so far! :clap:

My ideas:

  • I like the simple design!

  • when I use my wide screen, I’m having a hard time to read the texts; I think this is a combination of low color contrast, long lines, small font and small line height

  • in the sidebar, I would love to see a marker to show the current active section of the text!

Keep up the good work!

5

Thanks for the feedback. I’ll try to increase the font size and also add some line-height to give some spacing.

I tried to style the active links, it’s not working for me.
a:active and a:focus.
Is there a way to go about this??

I appreciate you doing this.

6

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

  • The test script should be included, with all tests passing, when you submit your projects.
    • Your page passes 14/16 user stories. Click the red button to see which test(s) are failing and text to help you correct the issue.
  • Run your HTML code through the W3C validator.
    • There are some minor issues you should be aware of. Very easy to fix.
    • You can ignore the warnings. There there to help with semantics but don’t need to be addressed.
  • Looking through your code I noticed how you did the snippets in the code element. Not sure if you know you could nest multi-line <code> snippets in <pre> </pre> tags in HTML to preserve whitespace and line breaks. Or you could do
code {
  white-space: pre;
}

in CSS and skip the <pre> tag in HTML.

8

@sythanh14, did you mean to reply to this thread? If not, please delete it.
Otherwise, please open a new thread with your code etc instead of impeding on the OP’s thread.
Thank you.

9

Thanks for the feedback, i’ll try to fix that.