Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Generated package docs are missing most of the info

Đang mở
  • Có gì không ổn?
#2,612 4 bình luận 2 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
3.6k
Fork
533
Merge trung bình
4 ngày 1 giờ
Pull request đã merge (30 ngày)
39

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của npmx-dev/npmx.dev

Tất cả issue của npmx-dev/npmx.dev

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.