NASA-AMMOS / slim

Software Lifecycle Improvement & Modernization
https://nasa-ammos.github.io/slim/
Apache License 2.0
27 stars 9 forks source link

[New Website Feature]: Improve best practice guide template based on markdown recommendations #161

Open riverma opened 5 months ago

riverma commented 5 months ago

Checked for duplicates

Yes - I've already checked

Alternatives considered

Yes - and alternatives don't suffice

Related problems

@nutjob4life pointed a couple of comments out that our best practice guide template is using some non-ideal best practice for Markdown. Specifically:

Describe the feature request

We should evaluate and apply improvements to the template based on Markdown best practices.

nutjob4life commented 5 months ago

Woot! Thanks @riverma. I've also updated my own guide to give a good motivation for preserving block/inline semantic markup:

Why do this? One tangible benefit is for accessibility: screen-readers use semantic structure to better present information for people with disabilities. For example, a screen reader can speak boldface text in an emphatic voice while keyboard shortcuts allow those with motor difficulties to navigate between headings. Using boldface as a heading defeats both of these assistive technologies.

Hope this helps with the motivation 💪 😁