NativeScript / NativeScript/docs

Improve search results

Đang mở
#132 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
JavaScript
Star
17
Fork
31
Merge trung bình
8 giờ 51 phút
Pull request đã merge (30 ngày)
2

Mô tả

I think there are 2 things to improve in the results, one is the order and the other is the name of the section in which they appear.
For example, in the image I show I am searching for stackLayout and searches related to stackLayout appear before the component itself.

  1. Improvement in order: When performing the search I think the entry to the component should appear first
  2. Incoherent titles: When searching for stackLayout the entry that is related to the component appears in the Documentation section. It's all documentation, right? I think a more coherent title would be the documentation space itself: UI Components.
  3. Incorrect section: This is related to the previous point, 2 StackLayout entries appear within Documentation, one is the component and the other is the API. This is quite confusing, I think each entry should appear with the title of the documentation section, for the component UI Components and for the API API Reference.
image

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

Mở 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.

Hướng nghiên cứu

Tái hiện tìm kiếm stackLayout được hiển thị trong issue và kiểm tra điểm vào của tìm kiếm cùng siêu dữ liệu của phần tài liệu. Xác nhận các mục thành phần và API được sắp xếp và gắn nhãn như thế nào. Được xem là hoàn tất khi các kết quả thành phần đứng trước các kết quả liên quan, với các mục thành phần được gắn nhãn UI Components và các mục API được gắn nhãn API Reference.

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

Đánh giá

Công nghệ
javascript
Lĩnh vực
documentation, search
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
38/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.