Skip to content

lrliang/asset-light

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

asset-light 文档索引

这份文档集解决什么问题

  • 如果你是第一次学 Rust:按顺序阅读 Rust 学习指南,并在本项目里完成每章的小练习。
  • 如果你要维护/扩展本项目:优先阅读项目技术文档,了解模块边界、数据流、数据库与调试方式。
  • 如果你在回看需求与设计:使用现有的 BMM 规划/设计文档作为“为什么做”和“要做到什么程度”的依据。

快速导航

BMM 规划/设计文档(已有)

推荐阅读顺序(第一次学 Rust)

  1. 先看 docs/rust-guide/README.md 的学习路线与章节说明。
  2. 跑通项目(cargo run),把应用窗口跑起来。
  3. 从“模块结构/所有权/错误处理”三章开始边读边改,形成 Rust 心智模型。
  4. 再进入“rusqlite 数据库”和 “Dioxus UI 与状态”的实战章节。

文档网站(GitHub Pages + mdBook)

本仓库提供 mdBook 构建配置,可将 docs/ 发布为静态网站:

  • 本地预览
    • 安装 mdbook 后运行:mdbook serve
    • 默认会在本地启动预览并自动刷新
  • 线上发布(GitHub Actions)
    • push 到 master/main 且变更包含 docs/** 时,会自动构建并推送到 docs 分支
    • 需要在 GitHub 仓库设置里启用 Pages(Source 选择 docs 分支)

文档约定

  • 以本仓库代码为准:若规划/设计文档与当前实现存在差异,以代码为最终事实,并在技术文档中说明差异与原因。
  • 每章都带练习:指南会尽量提供可以在本项目中直接完成的最小练习(可通过编译或 UI 行为验证)。

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published