admin2/openfreebooks-bookgenerator
1
0
Fork 0
mirror of https://github.com/HananoshikaYomaru/openfreebooks.git synced 2026-11-13 13:05:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update build scripts and enhance development workflow: Revise package.json to streamline build commands, replacing deprecated scripts with new chapter-specific build commands. Update CONTRIBUTING.md to clarify local development instructions and improve chapter sync processes. Enhance README.md with updated serving and build commands for better user guidance. Add new types for Bun in devDependencies and update the feed and sitemap to reflect recent content changes.

Browse source
This commit is contained in:
Hananoshika Yomaru 2026-05-22 11:42:00 -07:00
parent 61963350e7
commit 5ac8e330ca
19 changed files with 501 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

12
spec.md
View file

@ -35,4 +35,14 @@ each chapter needs to have the following other than the core content:
5. questions bank - some exams questions from easy, intermediate, difficult, hardcore
6. reference (if any)
the order can be adjustable base on importance.
the order can be adjustable base on importance.
## Non-functional requirements
### Dev experience and performance
1. `bun run dev` must start fast and directly run `zola serve` only (no implicit sync/build/watch pipeline).
2. Chapter build workflow must prioritize fast feedback for content edits:
- avoid full frontend bundle rebuild unless frontend/site-shell code actually changed,
- keep chapter core rebuild path as lightweight as possible.
3. `build:chapter` is the default iterative workflow for chapter updates; it should minimize unnecessary I/O and avoid rebuilding unrelated assets.