DeepDocs

DeepDocs là một đại lý AI trên GitHub giúp duy trì tài liệu kỹ thuật của bạn luôn đồng bộ hoàn hảo với mã nguồn. Khi bạn cam kết thay đổi mã, nó sẽ quét toàn bộ kho lưu trữ để tìm các tài liệu cần cập nhật và tự động thực hiện các thay đổi cần thiết.

Khác với các công cụ tạo tài liệu truyền thống tạo file từ đầu, DeepDocs chỉ cập nhật những phần cần thay đổi đồng thời giữ nguyên phong cách và định dạng gốc của bạn. Nó hoạt động với các công cụ tài liệu phổ biến như Docusaurus, Mintlify, MkDocs và Read the Docs.

DeepDocs cung cấp phiên bản miễn phí cho các dự án cá nhân với 10 lượt quét mỗi tháng, và phiên bản Pro dành cho các nhóm phát hành mã thường xuyên, cung cấp 100 lượt quét mỗi tháng và hỗ trợ lên đến năm file hoặc thư mục tài liệu cùng lúc.

Bắt đầu với DeepDocs rất đơn giản và mất khoảng hai phút. Dưới đây là các bước:

• Cài đặt ứng dụng DeepDocs từ GitHub Marketplace trên kho lưu trữ chứa mã nguồn và tài liệu của bạn. Nếu tài liệu của bạn nằm trong một kho lưu trữ riêng biệt, hãy cài đặt nó ở đó.

• Tạo một tệp cấu hình có tên deepdocs.yml ở thư mục gốc của nhánh chính. Tệp này cho DeepDocs biết những tệp hoặc thư mục tài liệu nào bạn muốn giữ đồng bộ với mã của mình.

• Cam kết tệp cấu hình vào kho lưu trữ của bạn. DeepDocs sẽ ngay lập tức quét toàn bộ mã nguồn, phát hiện bất kỳ tài liệu lỗi thời nào và gửi cho bạn một báo cáo chi tiết qua email với các đề xuất sửa chữa.

• Sau khi thiết lập ban đầu, DeepDocs sẽ tự động hoạt động trên mọi lần cam kết tiếp theo, quét các thay đổi của bạn và cập nhật tài liệu liên quan trong các nhánh riêng biệt để bạn xem xét trước khi gộp.

• Cập nhật tài liệu tự động với mỗi lần commit

• Quét toàn bộ kho lưu trữ mỗi khi có thay đổi mã

• Chỉ cập nhật các phần lỗi thời trong khi giữ nguyên định dạng

• Báo cáo chi tiết về các thay đổi tài liệu

• Tích hợp gốc với GitHub trong quy trình pull request

• Hoạt động với monorepos và các kho tài liệu riêng biệt

• Hỗ trợ Docusaurus, Mintlify, MkDocs, Read the Docs

• Cập nhật thông minh mà không cần viết lại toàn bộ

• Thông báo qua email với kết quả quét

• Quy trình thiết lập dễ dàng trong hai phút