All: Modules in potential need of documentation

Đang mở
#367 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.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
20/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
jquery
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem lại boilerplate của tài liệu và cách xử lý hiện có đối với nhóm exclude được mô tả trong issue, sử dụng mô-đun core làm ví dụ. Làm rõ những mô-đun nào trong danh sách cần tài liệu hoặc bản demo và những mô-đun nào nên bị loại trừ. Được xem là hoàn tất khi các quyết định đã được ghi lại và các mô-đun bị ảnh hưởng tạo ra metadata tài liệu như mong đợi hoặc được ẩn một cách nhất quán.

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

Mô tả

As I'm implementing the boilerplate for our library, I'm finding that I cannot produce a "docs" metadata field for some of our modules. Here are those we may (not) want to document/demo:

  • zoom
  • animationComplete
  • navigation/base (do we even need it anymore? https://github.com/jquery/jquery-mobile/issues/7489)
  • navigation/path (needs demos - maybe?)
  • widgets/controlgroup.backcompat (needs if ( $.mobileBackcompat ))
  • slider tooltip API (option popupEnabled and showValue)
  • textarea autogrow has no demo
  • $.mobile.iosorientationfixEnabled needs to be documented in global options (also, demo?)
  • accordion - docs and demos
  • support - do we want docs/demos?

Can we use the "exclude" group to hide modules in the DB? I've encountered

//>>group: exclude

For example, our core, which is merely a bundling of other modules, is labelled thus.

Ngôn ngữ chính
HTML
Star
55
Fork
57
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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 jquery/api.jquerymobile.com

Tất cả issue của jquery/api.jquerymobile.com

Issue tương tự

Thêm issue về Documentation

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.