Skip to content

Commit

Permalink
Merge pull request #1119 from mi6/1057-ensure-all-links-on-the-websit…
Browse files Browse the repository at this point in the history
…e-dont-include-the-full-stop-at-the-end-of-the-sentence

docs(root): removed fullstops within links for a11y
  • Loading branch information
MI6-286 authored Sep 12, 2024
2 parents 02462a5 + b846694 commit 0a20e92
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 124 deletions.
119 changes: 1 addition & 118 deletions src/content/structured/accessibility/coding/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ path: "/accessibility/coding"

navPriority: 4

date: "2022-11-15"
date: "2024-09-11"

title: "Coding for accessibility"

Expand Down Expand Up @@ -41,120 +41,3 @@ Planning for [full manual testing](/accessibility/testing/manual-testing/#full-m
The Design System and its UI Kit includes automated, manual and user-led accessibility testing. We are confident our components and patterns exceed minimum accessibility standards.

Check whether other third-party external libraries you use have been tested. Consider if the vendor or community is performing enough accessibility testing.

## References

The content in this section has been adapted from the following resources:

<ul>
<li>
<ic-link
target="_blank"
href="https://www.w3schools.com/html/html5_syntax.asp"
rel="noreferer noopener nofollow"
>
HTML Style Guide and Coding Conventions
</ic-link>
. W3Schools. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://www.webfx.com/blog/web-design/20-html-best-practices-you-should-follow"
rel="noreferer noopener nofollow"
>
20 HTML Best Practices You Should Follow
</ic-link>
. WebFX. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://blog.tbhcreative.com/2015/08/10-best-practices-in-html.html"
rel="noreferer noopener nofollow"
>
10 HTML best practices for beginners
</ic-link>
. TBH Creative. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://medium.com/oceanize-geeks/15-html-best-practices-that-developers-should-know-cb02473d293f"
rel="noreferer noopener nofollow"
>
15 HTML Best Practices That Developers Should Know
</ic-link>
. Medium. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://medium.com/swlh/10-best-practices-for-html-542fb923b93"
rel="noreferer noopener nofollow"
>
10 Best Practices for HTML
</ic-link>
. Medium. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://code.tutsplus.com/tutorials/30-html-best-practices-for-beginners--net-4957"
rel="noreferer noopener nofollow"
>
30 HTML Best Practices for Beginners
</ic-link>
. Envato Tuts Plus. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://github.com/hail2u/html-best-practices"
rel="noreferer noopener nofollow"
>
HTML Best Practices
</ic-link>
. GitHub. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://learn.shayhowe.com/html-css/writing-your-best-code"
rel="noreferer noopener nofollow"
>
Writing Your Best Code, Learn to Code HTML & CSS
</ic-link>
. Shay Howe. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://www.themelocation.com/best-html5-practices/"
rel="noreferer noopener nofollow"
>
30 Best HTML5 Practices
</ic-link>
, Themelocation. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://www.aspirationhosting.com/best-practices/"
rel="noreferer noopener nofollow"
>
Best Practices in HTML that Web Developers Should Adopt
</ic-link>
. Aspiration Hosting. Accessed 10 November 2021.
</li>
<li>
<ic-link
target="_blank"
href="https://dev.to/alvaromontoro/allow-end-user-styling-overrides-2467"
rel="noreferer noopener nofollow"
>
Allow end-user styling overrides
</ic-link>
. DEV.to. Accessed 10 November 2021.
</li>
</ul>
6 changes: 3 additions & 3 deletions src/content/structured/styles/links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ path: "/styles/content-style/links"

navPriority: 5

date: "2024-04-19"
date: "2024-09-11"

title: "Links"

Expand All @@ -20,10 +20,10 @@ Avoid writing 'click here' or 'read more'.

| **Like this...** | **Not like this...** |
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| Find out about the <a href="#0">changes to the expense policy.</a> | Find out about changes to the expense policy. <a href="#0">Read more here.</a> |
| Find out about the <a href="#0">changes to the expense policy</a>. | Find out about changes to the expense policy. <a href="#0">Read more here</a>. |

Start with a verb when telling people to do something.

| **Like this...** | **Not like this...** |
| ----------------------------------------- | ------------------------------------ |
| <a href="#0">Read new expense policy.</a> | <a href="#0">New expense policy.</a> |
| <a href="#0">Read new expense policy</a>. | <a href="#0">New expense policy</a>. |
4 changes: 2 additions & 2 deletions src/templates/Homepage/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ const Homepage: React.FC = () => {
))}
<ic-typography variant="body">
<ic-link href={withPrefix(homepage.about.link)}>
{homepage.about.linkText}.
{homepage.about.linkText}
</ic-link>
</ic-typography>
</div>
Expand All @@ -137,7 +137,7 @@ const Homepage: React.FC = () => {
))}
<ic-typography variant="body">
<ic-link href={withPrefix(homepage.contribute.link)}>
{homepage.contribute.linkText}.
{homepage.contribute.linkText}
</ic-link>
</ic-typography>
</div>
Expand Down
2 changes: 1 addition & 1 deletion static/accessibility-statement-html-blank.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</head>

<body>
<a href="#main" class="offscreen skip-content">Skip to content.</a>
<a href="#main" class="offscreen skip-content">Skip to content</a>
<div class="center">
<div role="banner">
<div class="navigation-links">
Expand Down

0 comments on commit 0a20e92

Please sign in to comment.