LMS Hàng Hải Codebase Docs
Đây là cổng tài liệu học codebase LMS Hàng Hải theo dạng Just the Docs: có sidebar, search, TOC và link nhanh tới các report HTML đã sinh từ source hiện tại.
Nên đọc theo thứ tự
- Học Codebase LMS
- Bản đồ trả lời nhanh
- Kiểm toán độ sẵn sàng
- Sơ đồ thư mục và luồng file
- Luồng nghiệp vụ cần thuộc
- UX/UI và design system
- Search guide
- Source map
- Sơ đồ hệ thống
- Ma trận bao phủ tài liệu
- Vị trí file code
- Chạy local và sửa code
- Kiến trúc tổng quan
- API endpoint index
- SQL schema catalog
- DB sống và ERD DBeaver
- Deploy docs lên Cloudflare
- Thuật ngữ tra nhanh
- Roles và permission
- Publication versioning
- Câu hỏi bảo vệ
- Bộ câu hỏi luyện vấn đáp
- Kịch bản demo và báo cáo
- Kế hoạch ôn bảo vệ
- Checklist chất lượng docs
Tìm nhanh trong docs
Gõ Ctrl+K, rồi thử các từ khóa:
WiiiContextService submit-for-approval ORG_ADMIN Not a managed type V92 V130 sepay/webhook interactive-video/events Sơ đồ hệ thống Sơ đồ thư mục directory map Vị trí file code 78 application tables student_lesson_progress payment_transactions Thuật ngữ tra nhanh ABR Pointy content_blocks Ma trận bao phủ Bộ câu hỏi luyện Kịch bản demo Checklist chất lượng docs Bản đồ trả lời nhanh Kiểm toán độ sẵn sàng Cloudflare Pages docs.holilihu.online 12 luồng nghiệp vụ sơ đồ luồng nghiệp vụ Flow Map Trước Khi Tra File UX/UI và design system design token đổi màu SEO docs sitemap.xml
Report tương tác
- Handbook HTML: bản học tổng hợp có sơ đồ.
- Full File CodeMap: xem flow map trước, rồi tra 2.253 file theo path, module, role, symbol/class.
- Defense Study Guide: bản học nhanh trước báo cáo.
Cách chạy site tài liệu
Máy hiện tại đang chạy docs bằng Docker ở port ngoài 4010, vì port 4000 dễ trùng với frontend/tool khác. Cách khởi động lại:
cd E:\Sach\Sua\LMS_hohulili
docker rm -f lms-docs-site
docker run -d --name lms-docs-site -p 4010:4000 -v "${PWD}:/workspace" -w /workspace/docs-site ruby:3.3 bash -lc "gem install bundler -N && bundle install && bundle exec jekyll serve --host 0.0.0.0 --port 4000"
Sau đó mở http://127.0.0.1:4010.
Just the Docs chính thức hỗ trợ search, custom Sass và include override. Repo này dùng docs-site/Gemfile + docs-site/_config.yml, không vendor source của theme. Nếu muốn chạy Ruby trực tiếp, xem Chạy local và sửa code.