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

📚 Documentation: skip to content links need adding [a11y][TheA11y100] #278

Closed
2 tasks done
GrahamTheDevRel opened this issue Oct 25, 2023 · 6 comments
Closed
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@GrahamTheDevRel
Copy link

💭 Description

Issue

The docs are multi page, so we should have skip to main content link on each page.

skip to content link on W3C site

Why it matters

On multi-page sites (vs Single Page Application (SPA)) it is advisable to have "skip to content" links as they reduce the number of tab stops required to get to the page content each time you navigate to a new page.

Otherwise you have to tab past the whole menu to get to the page content.

Suggested fix

Add skip links, similar to the example skip links codepen here.

These are links that are not visible unless they receive keyboard focus.

Relevant Success Criterion WCAG

Bypass Blocks in WCAG

Additional Notes

Should be added to the main template / layouts as the first link on the page. Should come before any other active content on the page.

Found on stream on 2023-10-25

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@GrahamTheDevRel GrahamTheDevRel added the documentation Improvements or additions to documentation label Oct 25, 2023
@GrahamTheDevRel GrahamTheDevRel changed the title 📚 Documentation: skip to content links need adding [a11y] 📚 Documentation: skip to content links need adding [a11y][TheA11y100] Oct 25, 2023
@Nwakaego-Ego
Copy link

Hi Graham,

I came across your tweet regarding the issues you raised and I'm eager to contribute. I noticed that the Appwrite Website is built with Svelte and SvelteKit. Although I'm a junior React developer, I'm willing to learn and work on this project. Could you please let me know if this opportunity is open to beginners like me?

If not will it be possible to shadow anyone working on this project?

Your feed back is highly appreciated.

Thank you

@ketanbaitule
Copy link
Contributor

Hi, I would like to work on this

@ketanbaitule
Copy link
Contributor

Hi, The Svelte doc Skip To Content Link First Goes To Sidebar, And then to content.

We have 2 Options: Just follow the svelte one, or medium one which directly goes to main content first.

What do you want me to do so??

@GrahamTheDevRel
Copy link
Author

Hey @ketanbaitule Svelte Docs do it incorrectly as the point is to bypass the very long navigation.

So go to the main content. 👍🏼💗

@EVDOG4LIFE
Copy link
Contributor

EVDOG4LIFE commented Feb 29, 2024

@GrahamTheDevRel - wanted to circle back on this. It appears that https://github.com/appwrite/website/pull/359/files was merged in December and the skip to content is live. Are you able to verify that this feature was implemented appropriately?

I can see it by hitting tab once the page loads:

image

@EVDOG4LIFE EVDOG4LIFE self-assigned this Mar 1, 2024
@EVDOG4LIFE
Copy link
Contributor

Closing out as related PRs are merged, and skip to content links are active. Please reopen or create a new issue if more is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants