Document the public API of @usine/config in TSDoc

Đã đóng
  • Có gì không ổn?
#304 0 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
Đặc tả 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

Start in packages/config and read AGENTS.md and CONTEXT.md for the documentation rules and vocabulary. Document the 7 top-level exports first, then the 86 public subpath members and service operations; check relevant ADRs for rules that need links. Run pnpm build, then pnpm turbo run build --filter=@usine/docs and inspect the regenerated reference in apps/docs/src/content/docs/reference/api/config/; done means both builds pass and the missing TSDoc counts are zero.

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

Mô tả

Part of #294. In packages/config, 7 of 73 top-level exports and 86 of 99 own fields, methods and service operations of the public subpaths have no TSDoc (counted from the generated API reference at https://docs.usine.dev/reference/api/config/ on 2026-10-17).

Document each exported element in domain terms, as AGENTS.md asks: what it represents, what its arguments mean, and what callers can expect beyond the TypeScript signature. Use the vocabulary of CONTEXT.md. Link an ADR when it explains a rule. Plain sentences, no literary verbs for objects, no em dashes.

Scope: TSDoc only. No behaviour change, no renames. Do the exports first, then members and service operations. If an export turns out to be an implementation detail that should not be public, say so in the PR instead of documenting it.

Done when pnpm build passes and the counts above are zero in the regenerated reference (pnpm turbo run build --filter=@usine/docs, then open apps/docs/src/content/docs/reference/api/config/).

Decisions (2026-10-28)

  • Recount the gaps from a fresh pnpm turbo run build --filter=@usine/docs; the counts in #294 are from 2026-10-17 and stale.
  • Follow the merged siblings #320 (expression), #321 (durable), and #323 (executor): Google API-reference comments (AGENTS.md), ADRs cited as plain "(ADR NNNN)" text rather than relative links, and one changeset for the package.
  • Comments only; no behavior change.
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.