Johannes Kresner
bba0095bc0
Establish the monorepo, tooling, and starter apps so UI and gateway development can begin from a documented, runnable baseline.
32 lines
2.4 KiB
Markdown
32 lines
2.4 KiB
Markdown
# README Migration Map
|
|
|
|
This file maps the original README sections to their new documentation locations after the restructure.
|
|
|
|
| Old README section | Status | New location | Notes |
|
|
| --- | --- | --- | --- |
|
|
| Objective | Migrated | `docs/overview.md` | Covered in the Objective section. |
|
|
| System overview | Migrated | `docs/overview.md`, `docs/architecture.md` | Split between product scope and high-level architecture. |
|
|
| Components | Migrated | `docs/architecture.md` | Covered in Core Components. |
|
|
| Voice pipeline | Migrated | `docs/architecture.md` | Covered in Voice Pipeline. |
|
|
| Protocol | Migrated | `docs/protocol.md` | Covered in Event Protocol. |
|
|
| STT | Migrated | `docs/integrations.md` | Covered in STT (Speech-to-Text). |
|
|
| TTS | Migrated | `docs/integrations.md` | Covered in TTS (Text-to-Speech). |
|
|
| LLM layer | Migrated | `docs/architecture.md` | Covered in LLM Layer. |
|
|
| Tool system | Migrated | `docs/integrations.md` | Covered in Tool System and Safety Rules. |
|
|
| Gateway flow | Migrated | `docs/architecture.md` | Covered in Gateway Internal Flow. |
|
|
| Interrupt handling | Migrated | `docs/protocol.md` | Covered in Interrupt Handling Requirements and Mechanism. |
|
|
| State machine | Migrated | `docs/protocol.md` | Covered in State Machine. |
|
|
| Deployment | Migrated | `docs/deployment.md` | Covered in Deployment Layout. |
|
|
| Networking | Migrated | `docs/deployment.md` | Covered in Networking. |
|
|
| Security | Migrated | `docs/deployment.md`, `docs/integrations.md` | Deployment covers hosting/security posture; integrations covers tool safety. |
|
|
| Performance targets | Migrated | `docs/deployment.md` | Covered in Performance Targets. |
|
|
| Future extensions | Partially migrated | `docs/backlog.md`, `docs/overview.md` | Future work is tracked in the phased backlog; v1 exclusions are noted in Non-Goals for v1. |
|
|
| Non-goals | Migrated | `docs/overview.md` | Covered in Non-Goals for v1. |
|
|
| Naming | Migrated | `docs/architecture.md` | Covered in Naming. |
|
|
| Implementation order | Migrated | `docs/backlog.md` | Reframed as phased implementation backlog. |
|
|
| Key risks | Migrated | `docs/deployment.md` | Covered in Key Risks. |
|
|
|
|
## Intentionally not migrated as standalone sections
|
|
|
|
- `Future extensions` was not kept as its own top-level document section. It was intentionally folded into `docs/backlog.md` and `docs/overview.md` to keep future work and v1 exclusions close to planning and scope.
|