ember-learn / ember-learn/ember-cli-addon-docs

Auto-populate router entries and nav list

Đang mở
#199 1 bình luận 5 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
172
Fork
142
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Hey,

I've been using ember-cli-addon-docs for a project, it has been great for developing isolated components. Have found that there's a fair amount of boilerplate when adding something to the docs and thinking much of it can be automated.

Filtering the keys from requirejs.entries can yield all components/mixins/etc with addon doc md files, which can then be used to populate docsRoute entries in the router and build the navigation handlebars template for the docs viewer.

A method like autopopulateDocRoutes() would be nice to be able to add to a docsRoute() call to populate it with routes based on such auto-detection. For the template, a sub-component to viewer.nav like "nav.autopopulate" would also be fantastic to insert nav.section elements (for directories or types) and nav.item elements--inserted inline, rather than something replacing viewer.nav entirely, so it can appear alongside any other custom sections and items not represented by md files.

I built this functionality into a project to reduce trivial work and the number of merge conflicts when multiple team members are adding components to the docs, would love to see such a thing included by default.

Cheers

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

Xác định entry point docsRoute() và template/component viewer.nav, sau đó kiểm tra cách requirejs.entries và các file markdown tài liệu của addon hiện đang được expose. Hoàn thành khi các route và navigation section/item có thể được generate tự động trong khi vẫn giữ các custom route và inline nav content.

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

Đánh giá

Công nghệ
handlebars, javascript
Lĩnh vực
documentation, frontend
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
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
35/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.