git init
This commit is contained in:
39
docs/repository-structure.md
Normal file
39
docs/repository-structure.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Repository Structure
|
||||
|
||||
`KIS-TOiR` keeps the existing LLM-first generation philosophy and organizes the repository by meaning:
|
||||
|
||||
- `domain/`
|
||||
- canonical DSL inputs
|
||||
- DSL specification
|
||||
- `prompts/`
|
||||
- active prompt corpus used to drive generation
|
||||
- `docs/`
|
||||
- overview and repository-level architecture notes
|
||||
- `tools/`
|
||||
- helper scripts for summary generation and validation
|
||||
- `server/`
|
||||
- generated backend target output after generation; may be absent at the clean-slate start of a full regeneration run
|
||||
- `client/`
|
||||
- generated frontend target output after generation; may be absent at the clean-slate start of a full regeneration run
|
||||
- `db-seed/`
|
||||
- generated runtime/bootstrap output after generation; may be absent before a full regeneration run
|
||||
|
||||
The repository keeps LLM-first generation orchestration, but framework bootstrap is CLI-first:
|
||||
|
||||
- `server/` must remain a valid NestJS workspace baseline
|
||||
- `client/` must remain a valid Vite React TypeScript workspace baseline
|
||||
- repair a broken workspace before applying more domain-derived generation changes
|
||||
- future agents must treat forbidden generation patterns in `prompts/` as contract violations, not suggestions
|
||||
|
||||
Root-level files stay limited to repository-level artifacts such as:
|
||||
|
||||
- `README.md`
|
||||
- `package.json`
|
||||
- `docker-compose.yml`
|
||||
- `api-summary.json`
|
||||
- `toir-realm.json`
|
||||
- `.gitignore`
|
||||
|
||||
Generated root runtime artifacts such as `docker-compose.yml` and `toir-realm.json` are end-state outputs, not clean-slate prerequisites for `prompts/general-prompt.md`.
|
||||
|
||||
The repository does not introduce a new generator engine or compiler platform. It keeps the current LLM-first pipeline and makes it cleaner, more explicit, and easier to navigate.
|
||||
Reference in New Issue
Block a user