Viết tài liệu¶
Dưới đây là các bước bạn cần thực hiện để đóng góp tài liệu cho BeeWare Docs Tools.
Trước khi bắt đầu viết tài liệu, hãy đảm bảo rằng bạn có thể tạo tài liệu và đang làm việc trên một nhánh.
Cập nhật tài liệu hiện có¶
Nếu bạn đang chỉnh sửa các tài liệu hiện có, bạn cần tìm tệp trong thư mục
/docs/en. Cấu trúc tệp tuân theo cấu trúc trang, do đó bạn có thể tìm tệp bằng
cách sử dụng URL của tài liệu.
Thêm tài liệu mới¶
Nếu bạn đang thêm một tài liệu mới, bạn sẽ cần thực hiện thêm một vài bước nữa.
Bạn cần tạo tài liệu tại vị trí thích hợp trong thư mục docs/en. Để tiện thảo
luận, chúng ta sẽ giả định rằng bạn đang thêm một tài liệu mới có tên tệp là
new_doc.md.
Sau đó, bạn cần cập nhật tệp docs/en/SUMMARY.md để thêm tệp mới của bạn vào.
Tệp SUMMARY.md được tổ chức sao cho phản ánh cơ bản cấu trúc thư mục
docs/en, nhưng quan trọng hơn, nó quyết định trực tiếp cấu trúc của thanh bên
trái. Nếu bạn tìm thấy phần mà bạn định thêm tệp new_doc.md, bạn không cần
thay đổi bất cứ điều gì trong tệp SUMMARY.md nếu thấy đường dẫn có ký hiệu đại
diện được liệt kê. Ví dụ:
- ./path/to/directory/*
Nếu phần mà bạn định chèn new_doc.md là một danh sách các liên kết Markdown
riêng lẻ, bạn sẽ cần thêm một liên kết cụ thể đến liên kết của mình. Ví dụ:
- [Tài liệu mới của tôi](new_doc.md)
Viết tài liệu¶
Bây giờ bạn có thể mở tệp mong muốn trong trình soạn thảo của mình và bắt đầu viết.
Chúng tôi có một hướng dẫn phong cách tài liệu nêu rõ các nguyên tắc về việc soạn thảo tài liệu cho BeeWare.
Khi bạn đã hài lòng với tài liệu mới của mình, bạn có thể gửi yêu cầu pull kèm theo các thay đổi đề xuất.