Kho Tài liệu docs.sigma.video

Chào mừng bạn đến với kho tài liệu chính thức cho các sản phẩm của Sigma. Kho lưu trữ này chứa toàn bộ tài liệu hướng dẫn sử dụng, ghi chú phát hành, và tài liệu API.

🚀 Giới thiệu

Đây là nơi tập trung toàn bộ tài liệu kỹ thuật, được xây dựng và duy trì bởi đội ngũ Sigma. Mục tiêu của chúng tôi là cung cấp những hướng dẫn rõ ràng, chính xác và dễ tiếp cận nhất cho người dùng và các nhà phát triển.

📂 Cấu trúc Thư mục

Kho tài liệu được tổ chức một cách khoa học theo ngôn ngữ và sản phẩm để dễ dàng tra cứu và quản lý.

docs
├── en/                # Tài liệu tiếng Anh
│   ├── sigma-media-server/
│   ├── sigma-dai/
│   └── apis/
└── vi/                # Tài liệu tiếng Việt
    ├── sigma-media-server/
    └── sigma-dai/

• docs/en: Chứa toàn bộ tài liệu bằng tiếng Anh.
• docs/vi: Chứa toàn bộ tài liệu bằng tiếng Việt.
• Mỗi thư mục con bên trong (ví dụ: sigma-media-server) tương ứng với một sản phẩm.

🤝 Hướng dẫn Đóng góp (Contributing)

Chúng tôi luôn hoan nghênh mọi sự đóng góp để cải thiện chất lượng tài liệu. Để quá trình diễn ra suôn sẻ, vui lòng tuân thủ các bước sau:

1. Tạo nhánh mới: Luôn làm việc trên một nhánh mới, không bao giờ commit trực tiếp lên develop hoặc main.
2. Tuân thủ cấu trúc: Đảm bảo các file và thư mục bạn tạo ra tuân thủ đúng cấu trúc và quy tắc về index.md và front matter.
3. Tạo Pull Request: Sau khi hoàn tất, hãy mở một Pull Request (PR) vào nhánh develop. Gemini Code Assist sẽ tự động review và tóm tắt các thay đổi của bạn.

✨ Để xem hướng dẫn chi tiết đầy đủ về quy trình, cấu trúc file, định dạng và cách xử lý sự cố, vui lòng truy cập trang Confluence của chúng tôi tại đây: Hướng dẫn Viết và Đóng góp Tài liệu cho docs.sigma.video