coulomb/shard-wiki
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
shard-wiki/spec/README.md

20 lines
1.6 KiB
Markdown
Raw Normal View History

Reorganize documentation into canonical repository layout 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.
2026-06-08 13:55:27 +02:00
# spec/
Specification files that guide and guardrail implementation.
Background on document types: InfoTechPrimers on coulomb.social.
| File | Status | Role |
|------|--------|------|
spec: CoreArchitectureBlueprint — whole-system architecture from research The optimal architecture synthesised from INTENT + the full research arc: - Thesis: canonical at the edges, derived in the middle (orchestrator not engine) - Dual narrow waist: adapter contract (15 capability spectra) + page model - 6 layers + provenance/capability rails; L4 union/projection is a rebuildable cache - Federation-model taxonomy (plural/composable); two-axis projection model; moldable view registry; identity != placement; computational content in scope as page-model+projection, out as execution platform - Concrete src/ module layout with downward-only dependency rule - Canonical data flows; policy surface; tradeoffs; full traceability to INTENT/UCs References ArchitectureBlueprint.md as the L5 authorization sub-blueprint. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 00:41:14 +02:00
| `CoreArchitectureBlueprint.md` | draft for review | **Whole-system architecture** — layers, abstractions, load-bearing decisions (synthesised from all research) |
spec(SHARD-WP-0002): adapter contract (TSD §A, T11-T16+T18); workplan done Adds the normative Shard Adapter Contract as TechnicalSpecificationDocument §A: A.1 versioned capability contract (verbs + orthogonal-core spectra), A.2 verified conformance suite (profiles not self-asserted), A.3 attachment-mode taxonomy + image-is-not-a-store boundary, A.4 page model (incl. computational shapes, identity/placement/equivalence, layered provenance), A.5 history portability, A.6 syntax translation + fidelity report, A.7 addressing/navigation, A.8 gated computational content. Updates TSD references/UC-count/next-work. Flips all 18 WP-0002 tasks + workplan done. Design layer complete. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 02:25:50 +02:00
| `FederationArchitecture.md` | draft for review | federation design — *what the union does*: T1–T10 decision records + the federation-model taxonomy (SHARD-WP-0002) |
spec(SHARD-WP-0013 T6): wire-up + close-out spec/README + SCOPE list WikiEngineCoreArchitecture.md; CoreArchitectureBlueprint cross-links the engine as a canonical-mode shard (federation/union stay in the orchestrator). reuse-surface engine capability promoted D2->D3 (4204255). Marks T6 + SHARD-WP-0013 done. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 23:02:15 +02:00
| `WikiEngineCoreArchitecture.md` | draft for review | the native **headless, API-first wiki engine** — small page-store kernel + typed-extension framework, as a canonical-mode shard backend (SHARD-WP-0013) |
adr: ADR-0001 engine activation via feature-control (OpenFeature, availability-only) Records the accepted decision: shard-wiki's native engine uses feature-control via OpenFeature for per-shard extension activation (availability only, never authz), provider-pluggable with a LocalProvider standalone default (mirrors the identity ladder), at the engine layer, consuming the mature feature-control.evaluate slice. Adds spec/adr/ series + README; hub decision abf7830f recorded. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 23:48:49 +02:00
| `adr/` | living | Architecture Decision Records (ADR-0001: engine activation via feature-control) |
spec(SHARD-WP-0001): yawex-derived federation requirements (ADR-01..06); workplan done Delivers spec/FederationRequirements.md — six ADR-ready design notes mapping the yawex prior art onto the hardened CoreArchitectureBlueprint: ADR-01 cross-shard resolution (yawex PageLookUp states as a checklist, keyed on identity), ADR-02 namespace/path + shard roles (path=placement not identity), ADR-03 derived views core-vs-adapter (BackLinks/RecentChanges/AllPages/SiteMap core, Search hybrid), ADR-04 concrete provenance envelope fields, ADR-05 overlay/ patch/append lifecycle, ADR-06 wikilink+red-link extension (model core, render UI). Resolves findings open-Qs #1-#3; access-model thread ratified. Flips WP-0001 done. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 02:19:43 +02:00
| `FederationRequirements.md` | draft for review | yawex-derived union/federation design notes — resolution, namespace, derived views, provenance, overlay, links (ADR-01…06; SHARD-WP-0001) |
Reorganize documentation into canonical repository layout 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.
2026-06-08 13:55:27 +02:00
| `ProductRequirementsDocument.md` | draft scaffold | What the product must deliver |
spec(SHARD-WP-0002): adapter contract (TSD §A, T11-T16+T18); workplan done Adds the normative Shard Adapter Contract as TechnicalSpecificationDocument §A: A.1 versioned capability contract (verbs + orthogonal-core spectra), A.2 verified conformance suite (profiles not self-asserted), A.3 attachment-mode taxonomy + image-is-not-a-store boundary, A.4 page model (incl. computational shapes, identity/placement/equivalence, layered provenance), A.5 history portability, A.6 syntax translation + fidelity report, A.7 addressing/navigation, A.8 gated computational content. Updates TSD references/UC-count/next-work. Flips all 18 WP-0002 tasks + workplan done. Design layer complete. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 02:25:50 +02:00
| `TechnicalSpecificationDocument.md` | draft + §A | How the system is built; **§A = the normative shard adapter contract** (T11–T16, T18; SHARD-WP-0002) |
spec: CoreArchitectureBlueprint — whole-system architecture from research The optimal architecture synthesised from INTENT + the full research arc: - Thesis: canonical at the edges, derived in the middle (orchestrator not engine) - Dual narrow waist: adapter contract (15 capability spectra) + page model - 6 layers + provenance/capability rails; L4 union/projection is a rebuildable cache - Federation-model taxonomy (plural/composable); two-axis projection model; moldable view registry; identity != placement; computational content in scope as page-model+projection, out as execution platform - Concrete src/ module layout with downward-only dependency rule - Canonical data flows; policy surface; tradeoffs; full traceability to INTENT/UCs References ArchitectureBlueprint.md as the L5 authorization sub-blueprint. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 00:41:14 +02:00
| `UseCaseCatalog.md` | draft | 84 use cases promoted from c2 + yawex + ~23-system research |
| `ArchitectureBlueprint.md` | draft | Access, history, and identity sub-blueprint (the L0–L4 authorization ladder; referenced by CoreArchitectureBlueprint §9) |
Reorganize documentation into canonical repository layout 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.
2026-06-08 13:55:27 +02:00
Promote material from `research/` and reviewed items from `demand/` into spec
before treating it as implementation authority.
Reference in a new issue Copy permalink