Vietnamese Maintaining the Wiki

Duy trì Wiki

Các wiki trên GitHub là các kho Git riêng biệt. Giao diện dòng lệnh GitHub (gh) có thể xác thực Git, bật hoặc mở một wiki, và cung cấp bối cảnh kho lưu trữ, nhưng hiện tại nó không bao gồm lệnh gốc để tạo hoặc chỉnh sửa các trang wiki.

Thiết lập một lần

Trang đầu tiên phải tồn tại trước khi GitHub hiển thị kho wiki để sao chép. Wiki này đã được khởi tạo, vì vậy người duy trì có thể sử dụng trực tiếp quy trình làm việc cục bộ.

Xác thực và cấu hình quản lý thông tin đăng nhập Git:

gh auth login
gh auth setup-git

Sao chép kho wiki:

git clone https://github.com/Appshines/Voice2Win.wiki.git
Set-Location Voice2Win.wiki

Chỉnh sửa và xuất bản

Mỗi tệp Markdown là một trang. Tên tệp trở thành địa chỉ trang; ví dụ, Getting-Started.md được xuất bản dưới dạng Getting-Started. _Sidebar.md điều khiển thanh điều hướng bên.

Sau khi chỉnh sửa:

git add --all
git commit -m "Update Voice2Win user guide"
git push

Các thay đổi chỉ trở nên hiển thị với người đọc khi được đẩy lên nhánh mặc định của kho wiki.

Các lệnh GitHub CLI hữu ích

Mở wiki:

gh browse --wiki --repo Appshines/Voice2Win

Xác minh rằng tính năng đã được bật:

gh repo view Appshines/Voice2Win --json hasWikiEnabled

Bật nó nếu cần:

gh repo edit Appshines/Voice2Win --enable-wiki

Quy ước về nội dung

• Nhóm các trang theo ngôn ngữ và sử dụng nhãn nhất quán trong từng ngôn ngữ.
• Giữ Trang Chủ ngắn gọn và chuyển thông tin chi tiết sang các trang chuyên sâu.
• Cập nhật _Sidebar.md mỗi khi một trang được thêm, xóa hoặc đổi tên.
• Ưu tiên mô tả ổn định hơn là ảnh chụp màn hình theo phiên bản hoặc tên tệp tải xuống chính xác.
• Ghi rõ sự khác biệt giữa các nền tảng.
• Giải thích viết tắt ngay lần đầu xuất hiện trên trang.
• Không bao giờ công khai mã ghép nối, mật khẩu, nhật ký riêng tư hoặc ghi âm cá nhân.
• Kiểm tra tất cả các liên kết nội bộ sau khi đổi tên trang.

Hướng dẫn chính thức của GitHub: Thêm hoặc chỉnh sửa trang wiki.