Hướng dẫn viết tài liệu cho thư viện xnoapi

💬 Hỏi đáp & Hỗ trợ
1

Bạn muốn đóng góp tài liệu cho dự án xnoapi? Rất hoan nghênh sự tham gia của bạn!
Chỉ cần vài bước đơn giản để bắt đầu:

Các bước đóng góp

  1. Fork repository

  2. Viết tài liệu

    • Clone repository về máy:
      git clone https://github.com/yourusername/xnoapi.git
    • Thêm hoặc cập nhật tài liệu trong thư mục source/.
      Lưu ý: Chúng tôi sử dụng định dạng reStructuredText (.rst).

  3. Build thử tài liệu

    • Build tài liệu HTML trên windows:
      \.make.bat html
    • Mở file build/html/index.html để xem bản preview trong trình duyệt.

  4. Gửi Pull Request

    • Commit các thay đổi của bạn và đẩy lên GitHub:
      git checkout -b docs/your-topic
git add .
git commit -m "Thêm tài liệu về <chủ đề>"
git push origin docs/your-topic
    • Truy cập GitHub và tạo một Pull Request từ nhánh bạn vừa tạo.

Tiêu chuẩn viết tài liệu

Vui lòng đọc kỹ file CONTRIBUTING.md để nắm rõ:

  • Cấu trúc file và thư mục
  • Cách đặt tiêu đề, phân mục
  • Format code block
  • Phong cách viết (ngắn gọn, dễ hiểu, đúng kỹ thuật)

Cần thêm hướng dẫn gì?

Nếu bạn muốn đề xuất thêm tài liệu cho một API cụ thể hoặc gặp khó khăn khi build, hãy comment ngay bên dưới thread này hoặc tạo issue trên GitHub. Chúng tôi luôn sẵn sàng hỗ trợ!

Cảm ơn bạn đã đóng góp :flexed_biceps: