danielmiessler / danielmiessler/TheAlgorithm

README still describes the pre-rename "PRD" terminology (v4.0.0), while versions/TheAlgorithm_Latest.md is at v6.3.0 and uses "ISA"

Đang mở Phù hợp với người mới
#13 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
154
Fork
16
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The top-level `README.md`'s "How It Works" section still refers to the artifact as a "PRD" and cites v4.0.0 doctrine:

https://github.com/danielmiessler/TheAlgorithm/blob/main/README.md

`versions/TheAlgorithm_v4.1.0.md` shows this was intentionally renamed to "ISA" (with reasons given), and the currently-pinned spec, `versions/TheAlgorithm_Latest.md`, is at v6.3.0 and uses "ISA" throughout:

https://github.com/danielmiessler/TheAlgorithm/blob/main/versions/TheAlgorithm_Latest.md
https://github.com/danielmiessler/TheAlgorithm/blob/main/versions/TheAlgorithm_v4.1.0.md

The README appears to predate the rename and hasn't been updated to match the current pinned version — a new reader landing on the README first would learn outdated terminology. Happy to open a PR syncing the README to Latest.md's terminology if useful.

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Compare the top-level README.md "How It Works" section with versions/TheAlgorithm_Latest.md and the rename rationale in versions/TheAlgorithm_v4.1.0.md. Update the README's outdated "PRD" terminology and v4.0.0 reference to match the currently pinned ISA terminology and version, then verify the section is consistent with Latest.md.

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ài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
90/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.