generated from coulomb/repo-seed
Initial implementation
This commit is contained in:
55
docs/infospace-layout.md
Normal file
55
docs/infospace-layout.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Infospace Layout
|
||||
|
||||
An infospace is a file-backed project rooted at:
|
||||
|
||||
```text
|
||||
infospaces/<slug>/
|
||||
```
|
||||
|
||||
## Required Files
|
||||
|
||||
```text
|
||||
infospace.yaml
|
||||
artifacts/index.yaml
|
||||
```
|
||||
|
||||
`infospace.yaml` declares identity, topic, schema references, workflow
|
||||
references, discipline bindings, and viability thresholds. `artifacts/index.yaml`
|
||||
is the deterministic manifest of artifacts that have been added to the
|
||||
infospace.
|
||||
|
||||
## Required Directories
|
||||
|
||||
```text
|
||||
artifacts/sources/
|
||||
artifacts/generated/
|
||||
output/evaluations/
|
||||
output/metrics/
|
||||
reports/
|
||||
exports/
|
||||
```
|
||||
|
||||
## Artifact Manifest
|
||||
|
||||
Artifacts are represented by stable IDs such as `source/chapter-01.md`.
|
||||
|
||||
Each manifest entry records:
|
||||
|
||||
- `id`
|
||||
- `path`
|
||||
- `kind`
|
||||
- `title`
|
||||
- `provenance`
|
||||
- `relationships`
|
||||
|
||||
The manifest is intentionally plain YAML so it can be inspected, diffed, and
|
||||
regenerated by tools or agents.
|
||||
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
python3 -m infospace_bench create . pilot --name "Pilot Infospace"
|
||||
python3 -m infospace_bench add-artifact infospaces/pilot ./source.md --kind source
|
||||
python3 -m infospace_bench inspect infospaces/pilot
|
||||
python3 -m infospace_bench export infospaces/pilot
|
||||
```
|
||||
Reference in New Issue
Block a user