processing / processing/processing-website

Core reference and Libraries reference entries share the same template

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

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

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

Mô tả

Because there's a single template to build all of the reference pages, the Library reference pages have the wrong left-nav option selected (Reference and not Libraries). Also, they can't have a custom message at the top of the page about the Javadoc. I think this requires digging into java-generate and rebuilding the Java classes.

In addition, the non-core Libraries from the Processing Foundation (Video and Sound) can't have a separate header message. They link to the Libraries Javadoc, but the code isn't there. Thinking about this more, we could probably build those Javadocs and add them while the rest are built.

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.

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra template dùng chung cho các trang tham chiếu và entry point java-generate được đề cập trong issue, sau đó lần theo cách các lớp Java được xây dựng lại. Công việc được xem là hoàn tất khi các trang Library chọn Libraries trong phần điều hướng bên trái, hỗ trợ các thông báo Javadoc tùy chỉnh, và các trang Video và Sound xử lý các liên kết Javadoc hoặc các Javadocs được tạo theo đúng mục đích.

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

Đánh giá

Công nghệ
java
Lĩnh vực
documentation
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
42/100

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.