docs: add initial project architecture, concepts, and quick-start documentation
This commit is contained in:
31
docs/README.md
Normal file
31
docs/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# AIWorkspace Documentation
|
||||
|
||||
AIWorkspace is a local context platform for developers. It connects project evidence, canonical human-readable memory, local services, and AI clients without making any single AI tool the source of truth.
|
||||
|
||||
This documentation describes the target production architecture: reusable AIWorkspace core separated from project-specific AI context packs.
|
||||
|
||||
## Start Here
|
||||
|
||||
- [Concepts: Overview](concepts/overview.md)
|
||||
- [Concepts: Workspace vs Context Pack](concepts/workspace-vs-context-pack.md)
|
||||
- [Architecture: Storage Model](architecture/storage-model.md)
|
||||
- [Guide: Quick Start](guides/quick-start.md)
|
||||
- [Reference: Project Manifest](reference/project-manifest.md)
|
||||
|
||||
## Documentation Map
|
||||
|
||||
```text
|
||||
docs/
|
||||
concepts/ Product concepts and user-facing mental model
|
||||
architecture/ System boundaries, storage, services, and security
|
||||
guides/ Task-oriented setup and usage guides
|
||||
reference/ File formats, CLI, manifests, and environment variables
|
||||
```
|
||||
|
||||
## Core Principle
|
||||
|
||||
```text
|
||||
AIWorkspace provides context. Project context packs own project memory.
|
||||
```
|
||||
|
||||
The core product should remain reusable and shareable. Project-specific facts, connector settings, people, channels, raw evidence, and prompts belong in separate context packs.
|
||||
Reference in New Issue
Block a user