shard-wiki/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

# shard-wiki
2026-05-15 21:23:05 +00:00
Git-based Markdown wiki orchestrator and federation layer.
`shard-wiki` joins heterogeneous wiki-shaped page stores (**shards**) into a
coherent information space while preserving provenance, capabilities, and
history. It is an orchestration layer, not a wiki engine.
## Status
Early-stage: Python scaffold, intent and specification groundwork, active design
workplan. See `SCOPE.md` for current maturity.
## Documentation
| Document | Purpose |
|----------|---------|
| [INTENT.md](INTENT.md) | Aspiration and boundaries |
| [SCOPE.md](SCOPE.md) | What we achieve now |
| [AGENTS.md](AGENTS.md) | Agent working guide |
| [docs/repository-layout.md](docs/repository-layout.md) | How this repo organizes information |
## Quick start
```bash
pip install -e ".[dev]"
pytest
```
## Layout
```
research/ explorations (yymmdd-prefixed)
demand/ inbound unreviewed requirements
spec/ implementation specifications
workplans/ State Hubregistered tasks
docs/ stakeholder documentation
wiki/ collaborative knowledge (wiki UI when connected)
issues/ ticket mirrors
history/ archived material (yymmdd-prefixed)
```