A couple of suggestions / questions

[aegiz]

Below are listed a couple of suggestions / questions I had following the audit I performed on the public code website (see also this PR #45 ):

• [ ] While auditing the CSS I found quite a lot of colors listed in in the rouge-highlight.css file. I am not sure you need all of them?
• [ ] On the 404 page https://publiccode.net/hello (but it might be present on some other pages as well) I saw that an h2 heading was skipped in the metadata sidebar: https://share.getcloudapp.com/rRuol10D
• [ ] It's probably better to not use element in the sidebar regarding accessibility issues.
  [ ] I found the README instructions of the blog repo super useful. Maybe the one on the about one should be updated to reflect this as well?
  bvhme commented 3 years ago

  Hey @aegiz, thanks for the great remarks! We'll try to resolve some of them.

  Could you elaborate on " It's probably better to not use element in the sidebar regarding accessibility issues." I don't understand what you mean.

  The Rouge CSS is of the syntax highligher, this will color code examples that are created so that they are easy to read. Thus the unused colors are to be used by users of the theme.

  We've removed the headings generated in the sidebar when there are non in the markdown, so that should at least fix the HTML issue, but we did not investigate why sections on the 404 are not recognised.

  Thanks again :)

  aegiz commented 3 years ago

  My pleasure :-)

  Re-reading my comment, you are right it was not very clear. The third suggestion refers to a table element that you use in the sidebar but should probably be replaced by a regular div. Two notes to help you: -In the screenshot above I used Wave Accessibility Tool on this page

  • The file that is generating this table seems to be this one.
  bvhme commented 3 years ago

  Interesting and good catch. The data is a display of the metadata in the blog, and thus it felt natural for it to be in a table. I see however how this might actually be flow content, but I'm not necessarily convinced it is. However perhaps we should just go with the flow and focus on making this WAVE happy :)

  I'm curious as to what others think on this.

  • © Githubissues.
  • Githubissues is a development platform for aggregating issues.

[bvhme]

Hey @aegiz, thanks for the great remarks! We'll try to resolve some of them.

Could you elaborate on " It's probably better to not use element in the sidebar regarding accessibility issues." I don't understand what you mean.

The Rouge CSS is of the syntax highligher, this will color code examples that are created so that they are easy to read. Thus the unused colors are to be used by users of the theme.

We've removed the headings generated in the sidebar when there are non in the markdown, so that should at least fix the HTML issue, but we did not investigate why sections on the 404 are not recognised.

Thanks again :)

[aegiz]

My pleasure :-)

Re-reading my comment, you are right it was not very clear. The third suggestion refers to a table element that you use in the sidebar but should probably be replaced by a regular div. Two notes to help you: -In the screenshot above I used Wave Accessibility Tool on this page

• The file that is generating this table seems to be this one.

[bvhme]

Interesting and good catch. The data is a display of the metadata in the blog, and thus it felt natural for it to be in a table. I see however how this might actually be flow content, but I'm not necessarily convinced it is. However perhaps we should just go with the flow and focus on making this WAVE happy :)

I'm curious as to what others think on this.