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

fix: accessibility docs #3453

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

eugene-lazarev
Copy link

Проблема

  1. Неверная информация о теге <main> в документации о доступности;
  2. Опечатки.

Решение

Исправление информации и опечаток.

Ссылки

Чек-лист перед запросом ревью

  1. Добавлены тесты на все изменения
    ⬜ unit-тесты для логики
    ⬜ скриншоты для верстки и кросс-браузерности
    ✅ нерелевантно

  2. Добавлена (обновлена) документация
    ⬜ styleguidist для пропов и примеров использования компонентов
    ⬜ jsdoc для утилит и хелперов
    ⬜ комментарии для неочевидных мест в коде
    ✅ прочие инструкции (README.md, contributing.md и др.)
    ⬜ нерелевантно

  3. Изменения корректно типизированы
    ⬜ без использования any (см. PR 2856)
    ✅ нерелевантно

  4. Прочее
    ✅ все тесты и линтеры на CI проходят
    ✅ в коде нет лишних изменений
    ✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)

@zhzz zhzz requested a review from sashachabin June 26, 2024 07:36
@zhzz
Copy link
Member

zhzz commented Jun 26, 2024

Привет! Спасибо за PR. Посмотрим в ближайшее время.

@sashachabin
Copy link
Member

sashachabin commented Jun 26, 2024

Согласен с формулировкой насчёт только одного <main>

Есть оговорки насчёт <main hidden>, но, думаю, что их пока можно опустить:

5. Для разметки областей страницы используйте теги `<header>`, `<main>`, `<article>`, `<nav>`, `<section>`, `<footer>`.
В отличии от тега `<h1>` элемент `<header>` можно использовать несколько раз на странице, например, для заголовка модального окна. Так же, несколько раз можно использовать `<footer>`, `<article>`, `<section>`, `<main>`.
5. Для разметки областей страницы используйте теги `<main>`, `<header>`, `<footer>`, `<nav>`, `<aside>`, `<section>`, `<article>`.
Как и ранее рассмотренный тег `<h1>`, тег `<main>` можно использовать только один раз на странице, остальные — несколько раз (например, `<header>` можно использовать для заголовков разных модальных окон).
Copy link
Member

@sashachabin sashachabin Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Предлагаю убрать «как и ранее рассмотренный» — само упоминание неплохое, но лучше не создавать лишнюю связность в тексте

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Предлагаю для точности добавить ссылку на whatwg:

Подобно тегу `<h1>`, тег `<main>` можно использовать на странице только один раз ([кроме исключений](https://html.spec.whatwg.org/multipage/grouping-content.html#the-main-element:~:text=A%20document%20must%20not%20have%20more%20than%20one))

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

Successfully merging this pull request may close these issues.

3 participants