nushell / nushell/nushell.github.io
Move Philosophy into Book
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 258
- Fork
- 561
- Merge trung bình
- 3 giờ 20 phút
- Pull request đã merge (30 ngày)
- 15
Mô tả
The book does a great job on the How. It explains well how Nushell works. But it lacks a bit on the Why. The Introduction hints on it but it seems to get lost on the surface, e.g. "modern style of development", "modern feel", "UX polish". New users tend to want to know the Why first before the How.
The Philosophy section of the Contributor Book does a great job on the Why. But it's usually read only long after the How and only by people interested in the underlying details.
I'd like to propose moving the Why before the How. This means moving the Philosophy section into the main book before any concrete "Usage" sections. It would probably make sense to put it just after the Installation section.
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.
Hướng nghiên cứu
So sánh phần Philosophy trong Contributor Book với cấu trúc của sách chính, đặc biệt là các phần Installation và Usage. Di chuyển Philosophy vào sách chính, sau Installation và trước các phần Usage cụ thể; hoàn tất khi Why được trình bày trước How và vị trí cũ trong Contributor Book được xử lý.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 45/100