Catty Steve
26809df720
- Add workshop-schedule crate (petgraph-based DAG scheduling) - Implement all bake decorators with combinator chain execution - Refactor notify module: extract handler, rule, template, util, queue - Add NotificationQueue with priority/drain semantics - Enhance finalize plugin system with internal plugin registration - Update ExecutionContext and event types - Add per-crate AGENTS.md knowledge base files - Remove inline AGENTS.md files (consolidated into per-crate docs)
2.2 KiB
2.2 KiB
DOCS KNOWLEDGE BASE
OVERVIEW
mdBook project in zh-CN. Authoritative source for project conventions, coding style, and architecture docs. Build output at docs/book/ (gitignored).
STRUCTURE
docs/
├── book.toml # mdBook config (title, language=zh-CN)
├── src/SUMMARY.md # Sidebar nav — source of truth for page listing
└── src/zh-CN/
├── index.md # Landing
├── vol1_user/ # End-user documentation
├── vol2_admin/ # Admin reference: decorator cheatsheet, deployment,
│ # env vars, exit codes, plugin ref, security, troubleshooting
└── vol3_dev/ # Developer docs: architecture, code style, commit
# convention, testing, error handling, type system,
# design decisions, PR process
WHERE TO LOOK
| Task | Location | Notes |
|---|---|---|
| Sidebar/nav editing | src/SUMMARY.md |
Add entry here to surface a new page |
| Coding conventions | vol3_dev/code_style.md |
Naming, imports, formatting |
| Commit rules | vol3_dev/commit_convention.md |
feat/fix/docs/test/refactor/style |
| Error handling | vol3_dev/error_handling_patterns.md |
thiserror+anyhow+HasExitCode |
| Type system | vol3_dev/type_system_guide.md |
Newtypes, types/ module isolation |
| Testing strategy | vol3_dev/testing_strategy.md |
3 tiers: unit, integration, system |
| Anti-patterns | vol3_dev/design_decisions.md |
Documented design rejections |
| Architecture | vol3_dev/architecture.md |
Crate dependency graph, module map |
CONVENTIONS
- Language: All prose in zh-CN. Code blocks in Rust (default) or bash.
- Adding a page: Create
.mdundervolN_*/, then add toSUMMARY.md. - Formatting: Standard Markdown. mdBook preprocessors handle TOC and links.
- Cross-references: Relative paths from source root (e.g.,
../vol3_dev/code_style.md). - Code blocks: Fenced with language tag. No line numbers in docs.
- File naming:
snake_case.md.
COMMANDS
mdbook build # static site → docs/book/
mdbook serve # live preview at localhost:3000