mirror of
https://github.com/HananoshikaYomaru/openfreebooks.git
synced 2026-11-12 20:45:52 +00:00
48 lines
No EOL
2.4 KiB
Markdown
48 lines
No EOL
2.4 KiB
Markdown
## openfreebooks
|
|
|
|
this project is free internet textbooks for elementary schools to university students. completely free, static and open source.
|
|
|
|
this project is build using zola. interactivity by solid js. deployed to cloudflare.
|
|
|
|
catalog map feature uses Mermaid with pan and zoom interactions.
|
|
|
|
not markdown, html based. but in every page, we should have a copy as md button using [defuddle](https://github.com/kepano/defuddle).
|
|
|
|
we don't i18n. i18n will be solved in future by big companies.
|
|
|
|
search is supported by pagefind.
|
|
|
|
we have a catalog of subjects. Each subject will have chapters. Each chapters can be labelled (multiple) cirriculum. E.g. DSE, IB, A level. so that user knows if a chapter is needed in a cirriculum. Each subject should show all chapters by default (all cirriculum). chapters should be sequential in a tree structure. users can filter by themselves. in the chapter we don't specify or mention the cirriculum anymore.
|
|
|
|
we need to have a question bank feature. since this is purely static sites, question answer needs to be determined and able to grade in advanced.
|
|
|
|
question bank not only show answer but also steps, explanation, calcultion.
|
|
|
|
best practice for creating chapters: correctness (knowledge wise) > completeness > order and structure > accessibility > optimization > correctness of everything else (credits, reference etc.)
|
|
|
|
a textbook should only start when someone owns it and capable of completing it.
|
|
|
|
## Chapters requirements
|
|
|
|
### Maths
|
|
|
|
each chapter needs to have the following other than the core content:
|
|
|
|
1. history - when did people first study this? why? how?
|
|
2. derivation / calculation
|
|
3. check point / thought provoking questions
|
|
4. real life applications
|
|
5. questions bank - some exams questions from easy, intermediate, difficult, hardcore
|
|
6. reference (if any)
|
|
|
|
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. |