generated from coulomb/repo-seed
tegwick
dfff9ab42e
The modern bookend to the Xanadu/ZigZag dives: where those are unbuilt ideals, Roam shipped fine-grained addressing (:block/uid), live transclusion (block embeds), bidirectional links, and a queryable structured space (DataScript datoms + Datalog). Studied as a candidate DB-backed/API-attached shard (XWiki family) and as a concrete engine-hosts-adapter surface (Roam Depot onload/onunload over window.roamAlphaAPI). Added UC-50 (attach block-graph DB shard, block<->page mapping), UC-51 (adopt native span IDs as portable span addresses), UC-52 (delegate derived views to a shard's native query engine); enriched UC-32/34/35/38. Boundary: Roam is one candidate shard mapped into the Markdown-first page model, not a substrate and not the federation layer. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
2.7 KiB
Markdown
60 lines
2.7 KiB
Markdown
# SCOPE
|
|
|
|
## One-Liner
|
|
|
|
Git-based Markdown wiki orchestrator and federation layer — early-stage scaffold
|
|
with intent, research, and specification groundwork; domain model not yet
|
|
implemented.
|
|
|
|
## Mode Of Operation
|
|
|
|
Close the gap between this file and `INTENT.md` by exploring the problem space
|
|
(`research/`), reviewing inbound demand (`demand/`), refining specifications
|
|
(`spec/`), and implementing through registered workplans (`workplans/`).
|
|
Learnings update both SCOPE and INTENT where necessary.
|
|
|
|
## Current Status
|
|
|
|
| Layer | State |
|
|
|-------|-------|
|
|
| Code | Python package scaffold (`src/shard_wiki/`, smoke tests only) |
|
|
| Intent | `INTENT.md` established; authorization-in-core amendments drafted |
|
|
| Research | yawex prior art; c2 origins; federation concepts; wikiengines overview (`research/260608-*/`); XWiki/TWiki/Foswiki deep dives (`research/260613-*/`); Xanadu + ZigZag + Roam deep dives (`research/260614-*/`) |
|
|
| Demand | NetKingdom integration asks captured, not yet negotiated |
|
|
| Spec | Architecture blueprint drafted; UseCaseCatalog 52 UCs from research; PRD/TSD scaffolds |
|
|
| Work | `SHARD-WP-0001` active (6 tasks); `SHARD-WP-0002` active (10 tasks) |
|
|
|
|
## In Scope (today)
|
|
|
|
- Establishing repository documentation structure and specification groundwork.
|
|
- Federation design informed by yawex prior art (page resolution, namespaces,
|
|
derived views, provenance, overlays).
|
|
- Authorization model design (delegated authentication, core authorization).
|
|
- Shard adapter contract and wiki page model (to be specified, then implemented).
|
|
- Git-backed coordination journal for information spaces.
|
|
- State Hub workplan registration and consistency sync.
|
|
|
|
## Out Of Scope (today)
|
|
|
|
- A standalone wiki engine UI or rendering pipeline.
|
|
- Authentication, credential storage, or user directory implementation.
|
|
- Hard-coded editorial, sync, or conflict-resolution policy.
|
|
- Generic file mirroring independent of wiki-page semantics.
|
|
- Production deployment, multi-tenant operations, or enterprise IAM rollout.
|
|
|
|
## Boundary Rule
|
|
|
|
`shard-wiki` orchestrates wiki-shaped content across heterogeneous shards. It
|
|
provides mechanisms (federation, projection, overlay, patching, reconciliation);
|
|
policy (canonical source, conflict preference, access rules) remains explicit and
|
|
configurable. Identity comes from pluggable providers; authorization decisions
|
|
live in core.
|
|
|
|
## Current Planning
|
|
|
|
Design work is tracked in `workplans/SHARD-WP-0001-yawex-requirements.md`
|
|
(yawex-derived resolution, namespaces, overlays) and
|
|
`workplans/SHARD-WP-0002-federation-architecture.md` (federation architecture,
|
|
decisions, tradeoffs). Specification outputs land in `spec/`. Inbound
|
|
integration asks remain in `demand/` until reviewed and promoted into spec or
|
|
workplans. |