Define a naming style for prompt block titles

Đang mở Phù hợp với người mới
#3,185 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
78/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ệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần “Prompt examples” trong standards/page-structure.md và làm theo tìm kiếm được đề xuất, grep -rn 'prompt title=".* prompt"' sources, để tìm các tiêu đề cần đổi tên. Thêm quy tắc đề xuất về kiểu tiêu đề và cập nhật các tiêu đề phù hợp; hoàn tất khi hướng dẫn đã được ghi lại và các tiêu đề hiện có tuân theo hướng dẫn đó.

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

Mô tả

t-docs

Prompt block titles (```prompt title="…") follow two styles:

  • All 14 Academy titles end in "prompt", for example "Draft user README prompt", "Recommend pricing prompt", "Change input URL prompt" and "Log items prompt" (in sources/academy/webscraping/scraping_with_ai/). apify/apify-docs#3164 adds 4 more.
  • Platform titles don't, for example "Find a Google Maps Actor" and "Run a saved task".

The card already has a Copy prompt button, so the suffix repeats what the card shows. The "Prompt examples" section in standards/page-structure.md, added in apify/apify-docs#3164, says to set a title but not how to write one.

Proposal:

  1. Add a rule to standards/page-structure.md#prompt-examples, for example: "Write the title as a short imperative phrase in sentence case that says what the prompt does. Don't end it with 'prompt'."
  2. Rename the existing titles that end in "prompt" (grep -rn 'prompt title=".* prompt"' sources).
Ngôn ngữ chính
JavaScript
Star
82
Fork
240
Merge trung bình
3 ngày 17 giờ
Pull request đã merge (30 ngày)
73

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 apify/apify-docs

Tất cả issue của apify/apify-docs

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.