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

Adding a glossary at the end of tutorials

Đang mở
#682 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
markdown
Lĩnh vực
content, documentation

Hướng nghiên cứu

Bắt đầu bằng cách mở các tutorial Color và Objects được liên kết trong issue, đồng thời xem lại PDF Glossary Examples đính kèm cùng với cấu trúc hiện tại của chúng. Thêm một phần chú giải thuật ngữ nhất quán, gồm các thuật ngữ chính và định nghĩa, vào các tutorial văn bản được tham chiếu, để có thể dễ dàng tìm thấy các thuật ngữ ở cuối mỗi tutorial.

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

Mô tả

Which area of the website does this enhancement relate to?

Processing's text tutorials

Describe the enhancement

At the end of the tutorials on the Processing website, there could be a glossary at the end with key words of the tutorial and definitions for easy reference.

Why is this enhancement important?

When I was looking through them, I noticed there was lots of jargon scattered throughout the tutorials and not all of them were clearly defined (or were in a different linked page). For beginners, this might get confusing and they might spend a while going back and reading through the tutorial to figure out what words mean, so I thought a
glossary section would help.

The current format has some words linked to a different page. While this is useful, it can be inconvenient since it involves extra navigation of pages (and can get disorganized if the user opens them in another tab). This would keep key terms in a centralized, consistent location for each tutorial for quick referencing, which is especially in scenarios where a user has to go back to a previous tutorial to refresh their memory.

Additional context

The PDF includes example glossaries I wrote for the two text tutorials linked below.

Tutorials referenced:
Color
Objects

Glossary Examples.pdf

Ngôn ngữ chính
MDX
Star
90
Fork
122
Merge trung bình
1 giờ 43 phút
Pull request đã merge (30 ngày)
3

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 processing/processing-website

Tất cả issue của processing/processing-website

Issue tương tự

Thêm issue về Content

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.