Feature request (docs): add an "Accessibility" page documenting HugoBlox's built-in a11y features

Abierto Apto para principiantes
  • ¿Algo no está bien?
#3,334 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
html
Área
accessibility, documentation

Línea de trabajo

Comienza revisando la estructura de documentación existente y los comportamientos de accesibilidad enumerados en la propuesta. Consulta el issue #3335 para ver la nota complementaria sobre personalización y, después, añade una página de Accessibility que cubra las funciones enumeradas y enlace a esa nota; se considera terminado cuando la página se puede encontrar y cada comportamiento prometido está documentado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

proposal stale
Prerequisites
  • I have searched for duplicate or closed feature requests
  • I am mindful of the project scope
Proposal

Add an Accessibility page to the docs (e.g. under Reference or Guide) describing the a11y
features that are (or should be) built into every HugoBlox page, so site owners know what they get out of the
box and reviewers/institutions can point to it. Suggested outline:

  • Skip to content — every page renders a "Skip to main content" link as the first focusable
    element (visually hidden until focused) that jumps to the main landmark.
  • Landmarks — page content is wrapped in <main id="main-content">; header/footer are
    distinct regions.
  • Keyboard focus — interactive controls show a visible :focus-visible outline (including the
    action-link buttons on publications/projects).
  • Heading structure — section titles (collection, markdown, portfolio blocks) render as real
    <h2> headings, so the document has a proper outline for screen-reader navigation.
  • Descriptive names — social/profile icon links expose human-readable accessible names rather
    than raw icon slugs.
  • A short "how to keep it accessible when customising" callout linking to the companion note
    (see the customisation issue https://github.com/HugoBlox/kit/issues/3335).
Motivation and context

According to the readme, HugoBlox powers 150k+ sites, many of them academic/institutional. In these contexts, accessibility is commonly a hard requirement (WCAG/Section 508/EN 301 549). The theme now implements several WCAG 2.1 AA basics — bypass blocks (2.4.1), visible focus (2.4.7), info & relationships / headings (1.3.1), and name/role/value (4.1.2) — but the docs don't mention accessibility anywhere, so users can't tell what's covered or cite it.

Lenguaje dominante
HTML
Estrellas
9.8k
Forks
2.9k
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de HugoBlox/kit

Todos los issues de HugoBlox/kit

Issues similares

Más issues de Accessibility

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.