Bắt đầu nhanh

Hướng dẫn này sẽ giúp bạn thiết lập Guidebook Cloud từ đầu.

Bước 1: Đăng ký

  1. Truy cập console.guidebook.dev
  2. Đăng nhập bằng tài khoản Google hoặc email của bạn
  3. Nếu đây là lần đầu tiên, bạn sẽ được chuyển đến trang tạo tổ chức

Bước 2: Tạo tổ chức

  1. Nhập tên tổ chức (ví dụ: "Công ty ABC")
  2. Nhập slug - đây là định danh duy nhất cho tổ chức của bạn (ví dụ: cong-ty-abc)
    • Slug sẽ xuất hiện trong URL: https://guidebook.dev/cong-ty-abc/
    • Chỉ sử dụng chữ cái thường, số và dấu gạch ngang
    • Không thể thay đổi sau khi tạo
  3. Nhấn Create Organization

Bước 3: Cài đặt GitHub App

  1. Vào Settings > GitHub Integration
  2. Nhấn Install GitHub App
  3. Chọn tài khoản GitHub hoặc tổ chức GitHub mà bạn muốn kết nối
  4. Chọn repository cần cấp quyền truy cập cho Guidebook Cloud
  5. Nhấn Install để hoàn tất

Bước 4: Import repository đầu tiên

  1. Từ trang chính, nhấn Import Repository
  2. Chọn repository GitHub từ danh sách
  3. Nhập tên và slug cho repository
  4. Kiểm tra Documentation Path (tự động phát hiện từ book.json)
  5. Nhấn Import

Bước 5: Build và xem tài liệu

Sau khi kết nối:

  1. Nhấn Build để xây dựng tài liệu lần đầu
  2. Đợi build hoàn tất (thông thường mất 1-2 phút)
  3. Nhấn View để xem tài liệu đã xuất bản

Cấu trúc tài liệu yêu cầu

Repository của bạn cần có ít nhất:

SUMMARY.md      # Mục lục
README.md       # Trang chính

Ví dụ file SUMMARY.md:

# Mục lục

* [Giới thiệu](README.md)
* [Hướng dẫn](guide.md)
* [API](api/README.md)
  * [Authentication](api/auth.md)
  * [Endpoints](api/endpoints.md)

Bước tiếp theo