File tree Expand file tree Collapse file tree 7 files changed +136
-0
lines changed
Expand file tree Collapse file tree 7 files changed +136
-0
lines changed Original file line number Diff line number Diff line change 1+ name : Bug report
2+ description : Report a reproducible bug
3+ title : " [Bug]: "
4+ labels : [bug]
5+ body :
6+ - type : textarea
7+ id : summary
8+ attributes :
9+ label : Summary
10+ validations :
11+ required : true
12+ - type : textarea
13+ id : steps
14+ attributes :
15+ label : Steps to reproduce
16+ validations :
17+ required : true
Original file line number Diff line number Diff line change 1+ name : Feature request
2+ description : Propose an enhancement
3+ title : " [Feature]: "
4+ labels : [enhancement]
5+ body :
6+ - type : textarea
7+ id : problem
8+ attributes :
9+ label : Problem
10+ validations :
11+ required : true
12+ - type : textarea
13+ id : proposal
14+ attributes :
15+ label : Proposal
16+ validations :
17+ required : true
Original file line number Diff line number Diff line change 1+ ## Summary
2+
3+ ## Validation
4+
5+ - [ ] ` ruff check . `
6+ - [ ] ` pytest -q `
7+ - [ ] README/examples updated if behavior changed
Original file line number Diff line number Diff line change 1+ # Code of Conduct
2+
3+ Be respectful, specific, and constructive.
4+
5+ - Discuss behavior, not people.
6+ - Provide reproducible context when reporting issues.
7+ - Keep collaboration professional and solution-focused.
Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ ## Setup
4+
5+ ``` bash
6+ python3 -m venv .venv
7+ source .venv/bin/activate
8+ pip install -e " .[dev]"
9+ ruff check .
10+ pytest -q
11+ ```
12+
13+ ## Contribution Rules
14+
15+ - Keep behavior aligned with ` SKILL.md ` and ` references/ ` contracts.
16+ - Preserve MarkdownFlow syntax correctness and interaction determinism.
17+ - Add tests for any core generation behavior change.
18+ - Update docs/examples when interface behavior changes.
Original file line number Diff line number Diff line change 11# mdf-teaching-script-generator
22
3+ [ 中文文档] ( ./README.zh-CN.md )
4+
35Generate runnable lesson-level MarkdownFlow teaching scripts from structured lesson materials with controlled interaction and reusable variable flow.
46
57## Use Cases
Original file line number Diff line number Diff line change 1+ # mdf-teaching-script-generator
2+
3+ [ English README] ( ./README.md )
4+
5+ 将结构化课节素材生成可运行的 lesson 级 MarkdownFlow 授课提示词,保证交互可控、变量可复用、结构稳定。
6+
7+ ## 适用场景
8+
9+ - 将已分段课程素材批量转为按课节运行的 MarkdownFlow 提示词。
10+ - 在保持教学结构稳定的前提下,按课节替换具体内容。
11+ - 在课节内进行变量采集与后续分流反馈。
12+
13+ ## 边界说明
14+
15+ - 仅负责生成“单节授课提示词”,不负责整课打包发布。
16+ - 不改写上游课程事实口径,不替代课程内容审校。
17+ - 输入应为结构化课节对象(已完成清洗/分段)。
18+
19+ ## 3 分钟快速开始
20+
21+ ``` bash
22+ python3 -m venv .venv
23+ source .venv/bin/activate
24+ pip install -e " .[dev]"
25+ mdf-teaching-script-generator --input examples/lesson_input.json --output output/lesson_output.json
26+ python -m json.tool output/lesson_output.json | head -n 40
27+ ```
28+
29+ ## 最小可运行示例
30+
31+ 输入文件:[ ` examples/lesson_input.json ` ] ( ./examples/lesson_input.json )
32+
33+ 输出包含:
34+ - ` lesson_id `
35+ - ` lesson_title `
36+ - ` mdf_script `
37+ - ` used_variables `
38+ - ` depends_on_lessons `
39+
40+ ## 架构:Skill Core + Adapters
41+
42+ - Skill Core:[ ` src/mdf_teaching_script_generator/core.py ` ] ( ./src/mdf_teaching_script_generator/core.py )
43+ - 平台无关的课节脚本生成逻辑。
44+ - CLI Adapter:[ ` src/mdf_teaching_script_generator/cli.py ` ] ( ./src/mdf_teaching_script_generator/cli.py )
45+ - 可在本地与流水线直接运行。
46+ - OpenClaw Adapter:[ ` adapters/openclaw ` ] ( ./adapters/openclaw )
47+ - Claude Adapter:[ ` adapters/claude ` ] ( ./adapters/claude )
48+ - Codex Adapter:[ ` adapters/codex ` ] ( ./adapters/codex )
49+
50+ ## 多 Agent 兼容
51+
52+ - OpenClaw 调用示例:[ ` examples/openclaw_call.md ` ] ( ./examples/openclaw_call.md )
53+ - Claude 调用示例:[ ` examples/claude_call.md ` ] ( ./examples/claude_call.md )
54+ - Codex 调用示例:[ ` examples/codex_call.md ` ] ( ./examples/codex_call.md )
55+
56+ ## 与 AI-Shifu 的关系
57+
58+ 该仓库是 AI-Shifu 课程生产链路中的可复用技能组件之一。
59+
60+ - 官网:https://ai-shifu.com
61+
62+ ## 开发
63+
64+ ``` bash
65+ pip install -e " .[dev]"
66+ ruff check .
67+ pytest -q
68+ ```
You can’t perform that action at this time.
0 commit comments