Move gold samples under tests/, put executable user docs in public/, restyle view, and add catalog plus gh-pages publish workflow. Co-authored-by: Cursor <cursoragent@cursor.com>
Marqdo 开发文档
本目录存放各阶段设计、选型与路线图。
目录约定
| 路径 | 用途 |
|---|---|
research/ |
外部标准与调研 |
design/ |
语言设计(语法映射等) |
adr/ |
架构决策记录 |
roadmap/ |
实现路线与里程碑 |
当前文档
| 文档 | 摘要 |
|---|---|
| design/markdown-mapping.md | v0.1 语法宪法 |
| design/code-vs-comment.md | 叙述 / 可执行 / 外联 |
| design/return-hr-and-code-surface.md | 语句/返回/输出决议 |
| design/generated-yaml-manifest.md | 生成式 OKF 清单 |
| design/tech-stack.md | 实现栈对比 |
| adr/0001-implementation-language.md | Accepted:Rust 参考解释器;不用 Flex/Bison |
| design/dependencies.md | 依赖详单(无 Flex/Bison) |
| design/keywords.md | 英文最小关键字 / 内置 print input |
| design/call-arguments.md | 调用:具名 + 位置实参 |
| design/examples-and-tests.md | tests/ 金样例目录布局 |
| design/view.md | marqdo view / view output 黑白极简 + 静态文档 |
| design/user-site.md | 用户站:public/ → gh-pages |
| design/catalog-cli.md | marqdo catalog / sync OKF 清单命令 |
| design/bytecode.md | M5 字节码 / 双后端 |
| design/pipeline-debug.md | 流水线 --dump-* 可视调试 |
| dev-setup.md | 开发环境配置(Rust M0) |
| roadmap/interpreter.md | 正经解释器路线图 |
| research/okf-and-marqdo.md | OKF 调研 |
金样例与集成测试:tests/。面向访客的可执行文档:public/。Spike 存档:spike/。
写作原则
- 先宪法与路线图,再实现。
- 金样例不过 = 未完成。
- 示例统一
.mq.md。