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ự

  1. Học Codebase LMS
  2. Bản đồ trả lời nhanh
  3. Kiểm toán độ sẵn sàng
  4. Sơ đồ thư mục và luồng file
  5. Luồng nghiệp vụ cần thuộc
  6. UX/UI và design system
  7. Search guide
  8. Source map
  9. Sơ đồ hệ thống
  10. Ma trận bao phủ tài liệu
  11. Vị trí file code
  12. Chạy local và sửa code
  13. Kiến trúc tổng quan
  14. API endpoint index
  15. SQL schema catalog
  16. DB sống và ERD DBeaver
  17. Deploy docs lên Cloudflare
  18. Thuật ngữ tra nhanh
  19. Roles và permission
  20. Publication versioning
  21. Câu hỏi bảo vệ
  22. Bộ câu hỏi luyện vấn đáp
  23. Kịch bản demo và báo cáo
  24. Kế hoạch ôn bảo vệ
  25. Checklist chất lượng docs

Tìm nhanh trong docs

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

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.