26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# Project Improvement Plan
|
|
|
|
## 1. Organize Documentation
|
|
- [x] Solidify the documentation structure (Concepts, Guides, Reference, etc.)
|
|
- [x] Determine the target audience for different doc sections (Human vs. AI)
|
|
- [x] Refine the TDFDDD process documentation
|
|
- [x] Move/rename existing files to fit the new structure
|
|
|
|
## 2. Create the Golden Example
|
|
- [ ] Implement a full feature (e.g., Full Shipping Company) demonstrating TDFDDD + Effect
|
|
- [ ] Show pure `Schema.brand` primitives
|
|
- [ ] Show Discriminated Unions for State
|
|
- [ ] Show pure `decide` Policy returning `Either`/`Result`
|
|
- [ ] Show `workflow` using `Effect.gen` and `Match.value`
|
|
- [ ] Add tests for the example
|
|
|
|
## 3. Deployment Pipeline Standards
|
|
- [ ] Setup CI/CD pipeline (e.g., GitHub Actions)
|
|
- [ ] Add `pnpm typecheck`, `test`, `lint` steps
|
|
- [ ] Add a basic `Dockerfile` for easy deployment
|
|
|
|
## 4. Effect Best Practices & Tooling
|
|
- [x] Integrate `@effect/eslint-plugin` and configure rules
|
|
- [x] Create a "Review Agent" skill to evaluate code for Effect/TDFDDD best practices
|
|
- [x] Ensure type-inspectors and linters are properly hooked up
|