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

Re-do the Getting Started section #4071

Open
peholmst opened this issue Jan 17, 2025 · 2 comments
Open

Re-do the Getting Started section #4071

peholmst opened this issue Jan 17, 2025 · 2 comments
Assignees

Comments

@peholmst
Copy link
Member

peholmst commented Jan 17, 2025

Based on the concept of a Walking Skeleton.

@peholmst peholmst self-assigned this Jan 17, 2025
@StefanPenndorf
Copy link

Disclaimer: I'm not shure if this is the right place to put this note.

Although #3942 lays out the goal that "[...] The Getting Started section should contain everything you need to build a new application from scratch and deploy it to production (the "happy path"). It should be very hands-on, focusing on what you need to do rather than why."

I'd like to request that you take a11y into account when writing the "skeleton application". I followed most of the tutorial for hilla and ran a A11y check via Vaadin Copilot afterwards but got some red alerts because of missing landmark elements. The tutorial uses <header>. <SideNav> sets the correct role attribute. But there were no other landmarks, for example <main> used in the tutorial. Additionally the tutorial put the page title into the navbar slot - which looks good but from a visual perspective - but caused one of the red alerts from a11y check. If you have an idea how to solve that, the tutorial should already contain that solution.

I don't want to request that you describe those elements in lengthy detail in the tutorial. Maybe you don't describe them at all but the examples should contain the necessary boilerplate to produce an accessible app "the vaadin way".

@peholmst
Copy link
Member Author

peholmst commented Feb 6, 2025

@StefanPenndorf Thanks for your input, this was exactly the right place to put this note. I will take accessibility into account in the skeleton.

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

No branches or pull requests

2 participants