shard-wiki/spec/TechnicalSpecificationDocument.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

# TechnicalSpecificationDocument
Status: **draft scaffold** · Date: 2026-06-08
See InfoTechPrimers on coulomb.social for TSD conventions.
## 1. System Overview
Python package (`src/shard_wiki/`) implementing a federation orchestration
layer. Markdown-first, backend-neutral page model. Git-addressable coordination
per information space.
## 2. Implementation Stack
| Concern | Choice |
|---------|--------|
| Language | Python ≥ 3.11 |
| Layout | `src/` package, hatchling build |
| Tests | pytest |
| Lint/format | ruff |
## 3. Core Abstractions (to be specified)
| Abstraction | Description |
|-------------|-------------|
| Shard | Independently meaningful page store with sovereignty |
| Root entity | Joined information space shards attach to |
| Shard adapter contract | Versioned, capability-aware backend interface |
| Wiki page model | Paths, links, metadata, revisions |
| Projection | Lazy local view of remote content |
| Overlay | Non-destructive edit before remote mutation |
| Coordination journal | Git-backed change record |
## 4. Architecture References
- `spec/ArchitectureBlueprint.md` — access, history, identity delegation
## 5. Integration Boundaries
- Authentication delegated to external identity provider (reference:
net-kingdom + user-engine). See `demand/260608-netkingdom-integration-requirements.md`.
- No credential or secret storage in shard-wiki core.
## 6. Current Implementation
Package scaffold only (`__version__`, smoke tests). Domain model not yet coded.
## 7. Use Cases
`spec/UseCaseCatalog.md` — 25 use cases (UC-01UC-25) promoted from c2 wiki
origins and yawex prior-art research.
## 8. Next Specification Work
Outputs from `SHARD-WP-0001` tasks (page resolution, namespaces, derived views,
provenance, overlays, link semantics) will be incorporated here as they complete.