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

Fix documentation typos and broken links

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

Hướng nghiên cứu

Issue liệt kê các tệp cụ thể cần chỉnh sửa: docs/pelican-terminal-gap-research.md, packages/coding-agent/docs/rpc.md, SECURITY.md, packages/providers/src/api/openai-completions.ts và packages/coding-agent/src/core/compaction/compaction.ts. Bắt đầu bằng cách định vị các tệp này trong kho lưu trữ. Đối với mỗi tệp, thực hiện sửa chữa được chỉ định: cập nhật hoặc xóa liên kết bị hỏng, sửa đường dẫn tệp và sửa lỗi chính tả. Xác minh các thay đổi bằng cách kiểm tra các tệp đã sửa đổi cục bộ. Hoàn tất khi tất cả các vấn đề được liệt kê đã được giải quyết và không có lỗi mới nào được đưa vào.

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

Mô tả

untriaged

A docs and comments review found several problems that can confuse readers or point them to missing files:

  • docs/pelican-terminal-gap-research.md links to four comparison screenshots under pixel-art/pelican-terminal-gap-research/, but those files are not present in the repository.
  • packages/coding-agent/docs/rpc.md points to packages/agent/src/types.ts, although the current source is packages/agent-core/src/types.ts.
  • There are typos in SECURITY.md (Isuses, “non trustworthy”), packages/providers/src/api/openai-completions.ts (knwo), and packages/coding-agent/src/core/compaction/compaction.ts (settions).

Please update or remove the dead screenshot references, point the RPC guide to the current source path, and correct the spelling errors. A local audit checked 97 Markdown files and found no other broken relative links after these changes.

Ngôn ngữ chính
TypeScript
Star
654
Fork
55
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
43

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 stepfun-ai/Step-Code

Tất cả issue của stepfun-ai/Step-Code

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.