[workshop-sync] workshop/18-share-and-reuse.md: `gh aw add` shorthand lookup location unclear

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#5,269 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 3 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
62/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ệ
github, github-actions, markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Khẳng định nằm ở dòng 20 của workshop/18-share-and-reuse.md, còn ví dụ ở dòng 76 dùng dạng ba phần gh aw add. Chạy gh aw add --help và kiểm tra xem .github/workflows/ có được phân giải như một vị trí viết tắt hay không trước khi chỉnh sửa. Hoàn thành khi trang nêu tên thư mục mà dạng viết tắt thực sự tìm kiếm, hoặc hiển thị đường dẫn đầy đủ bốn phần hoặc URL blob cho các tệp trong .github/workflows/.

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

Mô tả

documentation

Workshop file reviewed

workshop/18-share-and-reuse.md

Problem

Line 20 says:

Any .md file in a .github/workflows/ folder of a repository you have read access to can act as a template

and line 76 shows gh aw add jsmith/my-workshop/daily-status.

The live gh aw add help (gh-aw v1.0.1) says the three-part form is owner/repo/workflow-name[@version] and "implicitly looks in workflows/ directory". It doesn't mention .github/workflows/ as the shorthand lookup location, so the page's claim is not supported by the CLI help.

Suggested fix

Clarify where the shorthand resolves. Either say the template should live in workflows/ for the shorthand to work, or show the explicit four-part form (owner/repo/workflows/workflow-name.md[@version]) or a full GitHub blob URL for files in .github/workflows/. Verify the actual behavior with gh aw add --help and a test before editing.

Files 19 (19-research-driven-training-node.md) and 20 (20-persistent-memory.md) were also reviewed with no issues found. Two external links (reusing-workflows, compilation-process) could not be checked against the doc URL map.

Generated by 🔍 Workshop Sync Check · copilot · auto · ~54 AIC · ⌖ ~1 AIC · ⊞ 4.7K · ◷

  • expires on Nov 3, 2026, 11:28 AM UTC
Ngôn ngữ chính
JavaScript
Star
58
Fork
40
Merge trung bình
4 ngày 4 giờ
Pull request đã merge (30 ngày)
8

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 githubnext/gh-aw-workshop

Tất cả issue của githubnext/gh-aw-workshop

Issue tương tự

Thêm issue về JavaScript

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.