Uniform links and `.md` file names to allow link checker to work without false flags
@alelom đang làm issue này rồi.
Từ ngày 24/11/2023.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
As highlighted in the link strategy (#84), we can uniform our file names to enable the powerful link checker ability. This is required to avoid false flags, as for example happens here: https://github.com/BHoM/documentation/pull/83#issuecomment-1825686188.
In a nutshell:
- Rename all
.mdfiles that have whitespaces in their name. Replace them with underscores or dashes (do we have a preference @al-fisher ? I think we've used dashes in some of them). - Replace all links to those files so they keep working in the exposed website and that the link checker doesn't detects them as false flags. This can be simply done by shift-dragging the file you want to link into the text.
See this comment for a strategy to identify all links to be uniformed.
- Ngôn ngữ chính
- C#
- Star
- 88
- Fork
- 18
- 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
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của BHoM/documentation
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
BHoM/documentation#143 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
BHoM/documentation#142 ·
-
Create a clear list of the official version supported for each external dependency.Có thể đã có người làm @adecler đã nhận 20 ngày trước. Đang mởtype:documentation
BHoM/documentation#141 · 1 người được giao ·
-
Add documentation for MultiAttributeCó thể đã có người làm @IsakNaslundBh đã nhận 28 ngày trước. Đang mở
BHoM/documentation#139 · 1 người được giao ·
-
Initial test to transition to ZensicalCó thể làm lại được @peterjamesnugent đã nhận 41 ngày trước và không có pull request nào đang mở. Đang mởtype:documentation
BHoM/documentation#138 · 1 người được giao ·
Tất cả issue của BHoM/documentation
Issue tương tự
-
[BUG]: Position intent set on a simple order is dropped when it becomes a bracket, OCO or OTO orderCó thể đã có người làm @RaphaelFakhri đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
alpacahq/alpaca-trade-api-csharp#903 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
joinrpg/joinrpg-net#5752 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug ux
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
CodeForFire/lagebuch#714 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
dimitar-radenkov/Pointframe#294 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
kind/feature-request
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Altinn/altinn-correspondence#2154 ·
Maintainer thường phản hồi trong vòng 1 ngày