Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

README for the docs Directory

This directory organizes the technical documentation under development for Project Tapestry, including requirements analysis, architecture design, decision records, governance, and work group documentation.

Directory Description
architecture/ TVA methodology, phased outputs (1–5), architectural options analysis, ADRs, diagrams — see Architecture documents
governance/ Anti-capture principle and governance design
strategic-plan/ Overall strategy for execution — the vision and the product requirements (PRD)
reference/ Consolidated technical reference docs (e.g. training paradigms, deployment and usage material, and a single-page architecture synthesis)
work-groups/ Lifecycle work-group charters for data governance, base training, sovereign alignment, evaluation/certification, security/privacy, infrastructure, deployment, and governance participation (subject to change)

Architecture documents

The directory index is architecture/README.md. Main artifacts under architecture/:

Document Description
architecture/0-tva-methodology.md TVA design process — phases, design principles, current status
architecture/1-stakeholder-map.md Phase 1 — who we serve, what they control, what they fear
architecture/2-pain-points.md Phase 2 — what's concretely broken for each layer today
architecture/3-value-propositions.md Phase 3 — what Tapestry offers that the status quo doesn't
architecture/4-design-goals.md Phase 4 — constraints the architecture must satisfy
architecture/5-architectural-options.md Phase 5 — option space and decision analysis toward an architectural thesis
architecture/diagrams/README.md Architecture figures (SVG in Markdown), embedding conventions, and preferred inline Mermaid style
architecture/decisions/ Architecture Decision Records (ADRs)

Reference documents

The reference/ directory holds material outside the TVA phase chain (comparison references, deployment notes, etc.):

Document Description
reference/glossary.md Definitions of Tapestry-specific terms (consortium training, Shared-Base Loop, Sovereign Build, etc.)
reference/training-approaches.md Centralized vs. federated vs. consortium training

Repository root README.md and AGENTS.md summarize how docs/ fits with website/, src/, and contributor workflows.

Writing conventions

When creating or editing Markdown under docs/:

  • Do not hard-wrap prose. Write each paragraph as a single logical line (or continuous soft-wrapped text in the editor). Avoid manual line breaks inside a paragraph for visual column width; let the viewer soft-wrap. Use a blank line between paragraphs, and hard breaks only where Markdown structure requires them (lists, headings, code fences, tables, etc.).