generated from coulomb/repo-seed
tegwick
4543f5dc43
The closest existing engine to shard-wiki's own design: DB-canonical (Postgres/MySQL/SQLite) but with a pluggable storage-module abstraction that bidirectionally syncs clean Markdown (+ YAML frontmatter) to Git (also FS/S3/Azure), each provider acting as backup or source of truth. Two big findings: (1) the storage-module interface is concrete adapter-contract prior art alongside Foswiki::Store, and the closer one (medium = Markdown in Git); (2) the engine-maintained bidirectional Git mirror is the ideal file-store attach (clean MD + git history) and, being bidirectional, makes git commit a write path (overlay/patch as a commit, no API). Also GraphQL API (introspection = capability discovery; selective fields = efficient projection) and authn-delegated auth modules + path-based rule ACL. Added UC-68 (engine-maintained bidirectional Git mirror, write-by-commit), UC-69 (typed/introspectable API for schema discovery + selective projection); enriched UC-06/36/38/40/42/57. Catalog now 69 UCs. Architecture for SHARD-WP-0002 T11/T14: storage-module abstraction as 2nd adapter-contract prior art, engine-maintained Git mirror as attach+write surface, GraphQL introspection for capability discovery. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
2.9 KiB
Markdown
60 lines
2.9 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 + Obsidian + Notion + Joplin + Logseq + local-first workspaces (Anytype/AFFiNE/AppFlowy) + Trilium + Wiki.js deep dives & shard-spectrum synthesis (`research/260614-*/`) |
|
||
| Demand | NetKingdom integration asks captured, not yet negotiated |
|
||
| Spec | Architecture blueprint drafted; UseCaseCatalog 69 UCs from research; PRD/TSD scaffolds |
|
||
| Work | `SHARD-WP-0001` active (6 tasks); `SHARD-WP-0002` active (16 tasks: T1–T10 federation + T11–T16 adapter contract) |
|
||
|
||
## 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. |