Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Docs: hand-duplicated props tables drift risk, missing a11y sections, no per-component changelog

Abierto
  • ¿Algo no está bien?
#879 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
react, typescript
Área
accessibility, documentation, frontend

Línea de trabajo

Comienza con apps/www/src/content/docs/components/button/props.ts, los tipos de props correspondientes de button.tsx y apps/www/source.config.ts para entender la generación actual de tablas. Revisa la documentación de los componentes para ver las secciones de accesibilidad existentes y packages/raystack/CHANGELOG.md para consultar los datos del changelog. La tarea estará terminada cuando las props documentadas ya no diverjan, los componentes mencionados tengan secciones de accesibilidad y los cambios en los componentes se reflejen en sus páginas de documentación.

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

Descripción

enhancement global

Summary

Component docs (apps/www) have the right shape — props table, live demo playground, accessibility notes — but three gaps showed up in a practices audit.

Issues found

  1. Props tables are hand-duplicated and can drift. Each component has a shadow props.ts file (e.g. apps/www/src/content/docs/components/button/props.ts) read by fumadocs-typescript's remarkAutoTypeTable (apps/www/source.config.ts:16-33,62) instead of being generated from the real component types. Comparing button/props.ts against the actual button.tsx:127-134 union already shows props omitted from the doc.

  2. Accessibility sections are inconsistent. Present on Button, Dialog, Checkbox, Tabs, Select, Sidebar. Missing entirely on Combobox, Menu, ContextMenu, and DataView — notably the most complex component in the library has no accessibility documentation.

  3. No per-component changelog. Only one repo-wide packages/raystack/CHANGELOG.md (changesets-generated), and it isn't linked or surfaced anywhere on the apps/www docs site. Consumers browsing a component's docs page have no way to see what changed for that component.

Suggested approach

  • Generate props tables directly from the real component source, or add a CI check that diffs the shadow props.ts files against the actual exported prop types so drift fails a build instead of shipping silently.
  • Backfill Accessibility sections for combobox, menu, context-menu, and dataview.
  • Surface per-component changelog entries on each docs page (even a filtered view of the existing changesets changelog would close most of the gap).

Notes

Found via a components.build practices audit (docs dimension).

Lenguaje dominante
TypeScript
Estrellas
69
Forks
13
Merge medio
3 d 15 h
PR fusionados (30 d)
24

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 raystack/apsara

Todos los issues de raystack/apsara

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.