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

docs: add open, catch-up, timeline and history to the CLI reference

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#5,386 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

@meghna810 đang làm issue này rồi.

Từ ngày 10/10/2026.

  • #5442 của @meghna810 — đang mở

Đá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
85/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

Bắt đầu với bảng văn bản trợ giúp trong packages/cli/src/help.ts, sau đó đọc các định nghĩa args trong packages/cli/src/commands/open.ts, catch-up.ts, timeline.ts và history.ts. Thêm một mục cho mỗi lệnh vào docs/packages/cli.mdx, theo bố cục của các mục lệnh hiện có, kèm các tùy chọn và một ví dụ. Hoàn thành khi mỗi lệnh trong bốn lệnh đều có một mục mà các tùy chọn được ghi lại khớp với args và đầu ra của --help.

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

Mô tả

difficulty/easy documentation help wanted triage/ready

Problem

Four commands that hyperframes --help lists are missing from the CLI reference page, docs/packages/cli.mdx:

Command Help text (packages/cli/src/help.ts)
open Open a project in the HyperFrames desktop app
catch-up See what was done in the desktop app since you last looked
timeline Print the project's tracks and clips
history List, undo and restore the project's recorded changes

timeline gets a passing mention in docs/developers/cli.mdx; the others only appear in the changelog.

Proposed solution

Add a section for each to docs/packages/cli.mdx, matching the format of the existing command sections: what it does, its options, and an example. The options come from each command's args in packages/cli/src/commands/{open,catch-up,timeline,history}.ts; --help on each command shows the same.

Acceptance criteria

  • Each of the four commands has a section in docs/packages/cli.mdx with its options and at least one example.
  • Every option documented matches the command's args definition.
Ngôn ngữ chính
TypeScript
Star
54.1k
Fork
4.9k
Merge trung bình
8 giờ 39 phút
Pull request đã merge (30 ngày)
736

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 heygen-com/hyperframes

Tất cả issue của heygen-com/hyperframes

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.