Bản chụp tài liệu · CLI 7.30.1 · SDK 2.6.53. Desktop dùng môi trường chạy đi kèm bản phát hành riêng. Các lệnh và ví dụ được giữ nguyên từ bản tiếng Anh. Bản tiếng Anh

Tạo và dùng AX Wiki đầu tiên

Trước khi bắt đầu

AX Wiki chuyển nguồn được chọn trong kho mã thành trang kiến trúc và quy trình. Đây là kiến thức kho mã, tách biệt với tài liệu website AX Code. Trước tiên kết nối nhà cung cấp và chọn mô hình dùng được. Quá trình tạo gửi bằng chứng đã chọn đến nhà cung cấp và có thể phát sinh phí.

Chạy từ thư mục dự án. Dự án Git dùng gốc worktree gần nhất, kể cả khi bắt đầu trong thư mục con. Kiểm tra bản checkout và quyết định có đưa tệp được tạo vào quản lý phiên bản không.

Xem trước và tạo

Kế hoạch hiển thị tệp và trang được chọn mà không gọi mô hình. Xem lại trước khi tạo:

ax-code wiki plan

Sau đó tạo bằng mô hình đã cấu hình, xác minh kết quả và mở trình đọc cục bộ:

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

Đầu ra mặc định là .ax-wiki/, bắt đầu từ .ax-wiki/quickstart.md; .ax-wiki/.manifest.json ghi nguồn và mã băm. Việc tạo có thể cập nhật khối chỉ dẫn Wiki trong AGENTS.md; dùng --skip-agents để bỏ qua bước này. Kiểm tra phần khác biệt tạo ra.

Đọc và đặt câu hỏi hữu ích

Bắt đầu từ trang hướng dẫn nhanh, theo các tệp được trích dẫn và hỏi quy trình được triển khai ở đâu. Trình xem hiển thị trang, trích dẫn và quan hệ đã ghi. Dừng trình xem CLI đang chạy bằng Ctrl+C.

Dùng Wiki để định hướng rồi kiểm tra mã và kiểm thử hiện tại. Với ký hiệu, nơi gọi và tham chiếu chính xác, dùng công cụ phân tích mã hoặc LSP. Trang mới không chứng minh phạm vi đầy đủ, tính đúng đắn hay hiệu năng thực thi.

Giữ nội dung cập nhật

Sau khi nguồn thay đổi, cập nhật trang bị ảnh hưởng và kiểm tra tình trạng:

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

Lệnh trạng thái vẫn có thể thành công khi chưa có Wiki; kiểm tra sự tồn tại và tình trạng được báo. Đầu ra cũ hay không lành mạnh cần điều tra. Trình xem CLI dùng ảnh chụp cố định: mở lại sau cập nhật.

Trong TUI hiện tại, /wiki-viz mở trình xem và yêu cầu bảo trì. Bảo trì tương tác khi rảnh được bật mặc định; công việc chính được ưu tiên. Chạy không giao diện không bật bộ lập lịch này.

Kiểm soát việc tạo

Gộp các thiết lập tùy chọn sau vào ax-code.json của dự án. Thay ID bằng mô hình khả dụng qua kết nối. Ví dụ này tắt bảo trì nền nhưng giữ các lệnh chạy tường minh:

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

--model provider/model được chỉ định rõ sẽ ghi đè mô hình Wiki cho lần gọi đó. Mô hình suy luận cần điều khiển suy luận thấp/tắt được nhận diện; chọn mô hình được hỗ trợ khác nếu chính sách từ chối yêu cầu.

Đặt ghi chú của người bảo trì trong khối bảo vệ để giữ chúng qua cập nhật:

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

Khôi phục khi gặp sự cố

Không có mô hình hoặc lỗi xác thực: xác minh quyền nhà cung cấp và mô hình Wiki đã cấu hình. Mô hình trò chuyện hoạt động không bảo đảm mô hình Wiki riêng cũng dùng được.
Hết thời gian hoặc bản dựng bị ngắt: kiểm tra ax-code wiki doctor và .ax-wiki/.build-report.json, xử lý nguyên nhân rồi thử lại. Trang tạm đã xác minh có thể được dùng lại; bản dựng thất bại không có nghĩa mọi trang đã xuất bản.
Xung đột sửa thủ công: giữ ghi chú trong khối bảo vệ và xem lại thay đổi trước khi thử lại. --force cho phép thay thế chỉnh sửa ngoài các khối đó; chỉ dùng khi có chủ ý.

Bước tiếp theo

Cấu hình Wiki, CI và khắc phục sự cố · Trình xem và xuất ngoại tuyến · Chọn mô hình · Trang tài liệu