generated from coulomb/repo-seed
tegwick
1c0c0efc56
Adopt CoulombSocial/HelixForge/MarkiTect documentation structure: - research/260608-yawex-prior-art/ — yawex exploration and sources - demand/ — inbound NetKingdom integration requirements - spec/ — PRD, TSD, UseCaseCatalog, ArchitectureBlueprint scaffolds - docs/ — stakeholder documentation and repository-layout guide - wiki/, issues/, history/ — scaffolded directories Add SCOPE.md and AGENTS.md. Update workplan paths and README.
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# 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. 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. |