Tài liệu OSBlog
OSBlog ("open source blog" — blog mã nguồn mở) là ứng dụng xuất bản Markdown song ngữ (Việt/Anh) xây dựng bằng Vite, React, TypeScript, Neon Postgres/Drizzle và Better Auth. Bộ tài
English: docs/index.md
OSBlog ("open source blog" — blog mã nguồn mở) là ứng dụng xuất bản Markdown song ngữ (Việt/Anh) xây dựng bằng Vite, React, TypeScript, Neon Postgres/Drizzle và Better Auth. Bộ tài liệu này nằm cùng kho mã nguồn và cũng được phục vụ trực tiếp: cùng các file này được đọc lúc build và lộ ra tại /docs (mục lục) và /docs/<slug> (?lang=vi cho bản tiếng Việt), qua src/server/docs.ts và được render bởi src/app/pages/DocsPage.tsx. Một trang có thể khai báo title, description, order trong khối frontmatter ---; nếu không, tiêu đề sẽ lấy từ # heading đầu tiên và mô tả lấy từ đoạn văn đầu tiên.
Nhãn trạng thái: mỗi trang tự nêu rõ trạng thái đã xác minh so với chưa xác minh ở gần đầu trang. Tính đến 2026-09-05, mã ứng dụng, trang quản trị, kiểm duyệt bình luận và cả hai adapter triển khai đã được xây dựng; 64 test unit/component/SQL integration và 2 test E2E trên browser compile đạt tại local; database Neon thật đã được cấp phát và migrate; Vercel production đã live trên cả hai hostname yêu cầu và route smoke đã đạt. Xem work/SUPERVISOR_REPORT.md để biết trạng thái release và các khoảng trống vận hành còn lại.
Tài liệu sản phẩm
| Trang | Nội dung |
|---|---|
| Giới thiệu | OSBlog là gì, dành cho ai, và vì sao dự án tồn tại |
| Bắt đầu | Cài đặt local, thiết lập biến môi trường, migrate/bootstrap/seed, chạy dev server |
| Trình soạn thảo Markdown | Trang quản trị thật: toolbar, chế độ edit/preview/split, slug, ảnh bìa + alt, trường SEO, draft/publish |
| Cấu hình | Toàn bộ biến môi trường, nơi đọc chúng, và biến nào là bí mật |
| Quản trị và bình luận | Ranh giới đăng nhập admin, CRUD category/post, kiểm duyệt bình luận ẩn danh |
| Triển khai | Local, VPS + Nginx, Vercel, và Netlify — kèm lệnh thật và những gì đã thực sự xác minh |
| Sao lưu và khôi phục | Lịch sử migration, kỳ vọng sao lưu database, và quy trình rollback |
| Media | GIF/MP4 walkthrough Cap đã xác minh và nguồn gốc bản ghi |
Tài liệu tham chiếu và kỹ thuật
Các tài liệu này có trước bộ tài liệu này và do các hạng mục công việc khác duy trì; chúng được liên kết ở đây để dễ tìm, không dịch lại toàn bộ:
- Kiến trúc (tóm tắt tiếng Việt) — bản tóm tắt; xem architecture.md (tiếng Anh) để có nội dung đầy đủ.
- Hệ thống thiết kế UI (tiếng Anh) — nguồn tham chiếu thị giác/khả năng tiếp cận đã lưu trữ.
- Vận hành và Autopilot (tiếng Anh) — quy ước vận hành/QA của quy trình UseAgent dùng để xây dựng kho mã này, không phải tài liệu về bản thân blog.
- Conformance (tiếng Anh) — kịch bản replay vòng đời UseAgent.
Bản tiếng Anh
Mỗi trang tiếng Việt đều có bản tiếng Anh tương ứng tại docs/, cũng được phục vụ tại /docs/<slug>:
- Introduction
- Getting started
- Markdown editor
- Configuration
- Admin and comments
- Deployment
- Backups and rollback
- Architecture (full)
- Media
Báo lỗi
Sử dụng kho GitHub thuanlyt/osblog để mở issue hoặc pull request. Xem CONTRIBUTING.md để biết quy trình đóng góp và SECURITY.md để báo lỗ hổng bảo mật.