ionic-team / ionic-team/ionic-docs

Documentation urls should always include version number

Đang mở
#1,736 1 bình luận 1 reaction 0 người được giao Xem trên GitHub
feature request structural
Ngôn ngữ chính
MDX
Star
621
Fork
3.2k
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
86

Mô tả

**Is your feature request related to a problem? Please describe.**
Old blog or forum posts, stackoverflow that links to the ionic docs often point to the wrong version of the documentation.
Examples :
- https://ionicframework.com/blog/introducing-ionic-4-ionic-for-everyone/ the link to the Migration guide is https://ionicframework.com/docs/building/migration/ but should be https://ionicframework.com/docs/v4/building/migration/
- https://stackoverflow.com/a/55202668/2765126 the link to the `css-custom-properties` links to the current doc that includes more properties than in v4 so it's confusing

**Describe the solution you'd like**
- Always include the version number in the documentation urls (even the current version)
- If no version is added redirect to current version (to prevent dead links)

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by locating how documentation URLs and versioned paths are generated in this repository, then inspect the routing or redirect configuration for unversioned links. Compare the current and v4 examples from the issue; done means versioned documentation URLs are used consistently and unversioned URLs redirect to the current version without breaking existing links.

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

Đánh giá

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
30/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.