Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
riverma opened this issue Jun 25, 2024 · 1 comment
Labels
website Improvement / fix to the SLIM website

Comments

@riverma
Copy link
Collaborator

riverma commented Jun 25, 2024

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.

@riverma riverma added the website Improvement / fix to the SLIM website label Jun 25, 2024
@riverma riverma moved this to 📋 Backlog in SLIM Planning Board Jun 25, 2024
@nutjob4life
Copy link

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 💪 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website Improvement / fix to the SLIM website
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants