TSDoc coverage gaps in the published packages

Đã đóng
  • Có gì không ổn?
#294 1 bình luận 0 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
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Read AGENTS.md and inspect the generated API reference at apps/docs/reference/api/ to identify undocumented public exports. Start with the core envelope classes, agents, and engine, then document their exports and service operations in domain terms. Also inspect packages/core/src/worker.ts:61 and fix the broken ADR 0027 link; done when the listed TSDoc gaps are covered and the package link works.

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

Mô tả

The generated API reference (/reference/api/ in apps/docs) shows how much of the public API has no TSDoc. AGENTS.md asks for every exported element to be documented in domain terms.

Package Undocumented exports Undocumented members
core 27/229 (the attempt/channel envelope classes) 153/166
agents 13/67 59/81
engine 13/70 103/151
orchestrator 10/102 186/205
github 9/83 64/77
config 7/73 86/99
gateway 1/75 77/88
durable 0/38 21/53
executor 0/33 30/67
expression 0/19 14/20

Members are own fields, methods, and service operations. Exports count top-level declarations, so a type and a value with the same name count twice.

Also: packages/core/src/worker.ts:61 links ADR 0027 with a relative path (../../../docs/adr/...), which is broken in the npm tarball; the docs site rewrites it to GitHub.

Start with the exports (core envelope classes, agents, engine), then service operations.

Ngôn ngữ chính
TypeScript
Star
1
Fork
0
Merge trung bình
4 giờ 26 phút
Pull request đã merge (30 ngày)
280

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 basaltbytes/usine

Tất cả issue của basaltbytes/usine

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.