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

Generated package docs are missing most of the info

Abierto
  • ¿Algo no está bien?
#2,612 4 comentarios 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

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
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Start by reproducing the missing documentation on the linked npmx.dev page for effect-web-midi and inspect its package.json exports map, especially the wildcard entrypoints. Then trace how the docs generator discovers exported symbols and their attached documentation. Done means the generated package docs include the documented exported functions across the package's entrypoints.

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

Descripción

back help wanted
Describe the bug

https://npmx.dev/package/effect-web-midi/

Docs generator doesn't look very deep to find the actual info about the exported symbols from the package. Due to the specific package organizational structure, many exported functions are not rendered, even though they have actual documentation attached.

https://npmx.dev/package-code/effect-web-midi/v/0.2.1/src%2Finternal%2FEMIDIAccess.ts

And it has more than one entrypoint (especially the ones with wildcards)

{
  "exports": {
    ".": {
      "types": "./dist-types/index.d.ts",
      "default": "./dist/index.js"
    },
    "./*.js": {
      "types": "./dist-types/src/*.d.ts",
      "default": "./dist/src/*.js"
    },
    "./*.ts": "./src/*.ts",
    "./*": {
      "types": "./dist-types/src/*.d.ts",
      "default": "./dist/src/*.js"
    },
    "./internal/*": null,
    "./package.json": "./package.json"
  }
}
Image
Lenguaje dominante
TypeScript
Estrellas
3.6k
Forks
533
Merge medio
5 d 1 h
PR fusionados (30 d)
36

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 npmx-dev/npmx.dev

Todos los issues de npmx-dev/npmx.dev

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.