docs: cite functions instead of line numbers in the CLI reference

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#193 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
86/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ệ
angular, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/reference/cli.md và xem lại mọi dòng Source:. Sau đó chạy git grep -n " lines\? [0-9]" docs/ để tìm các trang khác có tham chiếu dòng. Thay từng phạm vi bằng tên hàm hoặc hằng số trong tệp được tham chiếu, rồi kiểm tra xem từng tên có tồn tại trong tệp đó không. Chạy pnpm run build:docs. Công việc hoàn tất khi tài liệu tham chiếu CLI không còn số dòng trong các dòng Source: và quá trình build tài liệu thành công.

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

Mô tả

documentation good first issue

What is wrong

docs/reference/cli.md points to the code with line numbers, for example "apps/pidrang-cli/src/run-cli.ts lines 273-315 (planSignIn)". They go wrong at every change of the CLI: #185 had to move about fifteen of them.

Where to look

  • docs/reference/cli.md: every Source: line.
  • Other pages that do the same: git grep -n " lines\? [0-9]" docs/.

Steps

  1. Replace each line range by the function or constant name, which is already written next to most of them, for example "planSignIn in apps/pidrang-cli/src/run-cli.ts".
  2. When a range has no name, use the nearest function name.
  3. Do the same in the other pages you found, or list them in the pull request if there are many.
  4. Run pnpm run build:docs to check the pages still build.

Done when

  • docs/reference/cli.md has no line numbers left in its Source: lines.
  • Every name you wrote exists in the file it points to.
Ngôn ngữ chính
TypeScript
Star
2
Fork
2
Merge trung bình
9 giờ 17 phút
Pull request đã merge (30 ngày)
48

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

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 pidrang/pidrang

Tất cả issue của pidrang/pidrang

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.