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

Enhance curriculum structure and add new subjects: Update CONTRIBUTING.md with detailed guidelines for adding new subjects and their associated assets. Introduce English and Physics subjects in the catalog, along with their respective curriculum files and chapter structures. Implement shared styles for English and Physics chapters, and add interactive widgets for physics concepts. Update FAQ to clarify the use of AI in content creation, ensuring accessibility and durability of educational materials.

Browse source
This commit is contained in:
Hananoshika Yomaru 2026-05-20 19:10:55 -07:00
parent a2679aa4de
commit 5f14020cfa
26 changed files with 1530 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

27
CONTRIBUTING.md
View file

@ -158,10 +158,29 @@ Add edges in `data/{subject}-curriculum.json`:
## Add a new subject
1. `data/catalog.json` — add to `subjects`.
2. Create `data/{id}-curriculum.json` (copy structure from `math-curriculum.json`).
3. Wire the subject in `themes/openfreebooks/templates/catalog.html` (until auto-wire lands).
4. Add `content/{subject}/` when you have chapters.
1. `data/catalog.json` — add the subject to `subjects`.
2. Create `data/{id}-curriculum.json` (same schema as `math-curriculum.json`; `strands` + optional `graph.edges`).
3. Add `content/{subject}/` when you have live chapters.
4. Run `bun run build:js` (this syncs chapter content and auto-registers subject CSS/JS modules).
### Subject scaffold (copyable)
```text
data/
{subject}-curriculum.json
content/{subject}/
subject.scss # optional shared styles
subject.ts # optional shared JS init
{chapter-slug}/
_index.md # template = "chapter.html", extra.subject = "{subject}"
core.html # required
supplement.html # optional
chapter.scss # optional chapter-only styles
assets/ # optional
widgets/*.tsx # optional
```
No catalog/chapter template edits are required for new subjects when the subject is present in `data/catalog.json` and `data/{subject}-curriculum.json` exists.
---