Skip to content

Latest commit

 

History

History
81 lines (66 loc) · 3.92 KB

File metadata and controls

81 lines (66 loc) · 3.92 KB

zkc documentation

This directory is the public reading map. Authority is separated by kind so that implementation evidence, future plans, and normative semantics are not mistaken for one another.

Start here

Question Document
What is zkc, and what direction does it pursue? Project Overview
What does the current checkout claim? Current Status; the Repository README is a summary
How does the target architecture fit together? Architecture
How does zkc relate to relation compilers, formal systems, backends, and zkVMs? Ecosystem
How do I build it? Getting Started
What comes next? Roadmap
What are the exact artifact and judgment semantics? Specification Overview
What formal evidence is currently recorded? Formalization Evidence

Project Overview explains the stable project model and target direction without reporting current implementation support. Architecture is the non-normative target guide to system layers, artifact lifecycle, and trust boundaries; it intentionally includes unimplemented parts of the target design. Ecosystem applies those generic boundaries to concrete external projects without making a compatibility claim. Current Status owns the public capability and evidence dashboard. The setup guide owns the normal development workflow, while the roadmap owns dependency order; neither overrides the specification.

Normative specification

The current specification corpus is:

Specification Overview is the compact reading map. The individual specifications own intended semantics. Implementations and tests are conformance evidence; registry JSON and encoded artifacts remain subject to the validation and identity rules those specifications define.

Formalization evidence

Formalization Evidence explains the receipt and drift checks attached to Soundness Kernel rules, the pinned formalization readings, and the conditions for theorem-backed admission. The machine-readable annotations and pin files remain authoritative for their own contents; the document does not override the specification.

Evaluation and evidence records

These records preserve the exact scope and residual trust of experiments. They do not override Current Status, mint general backend conformance, or define protocol semantics.

Documentation rules

  1. Current public capability and evidence claims belong in status.md; future direction belongs in roadmap.md.
  2. Exact schemas, judgments, identities, and refusal rules belong in spec/.
  3. A demonstrated run establishes only the facets and fixed inputs it records.
  4. Soundness, completeness, zero knowledge, relation satisfaction, backend conformance, and implementation correctness are separate claims.
  5. A placeholder, proposal, citation, receipt, or passing test does not acquire stronger authority through proximity or detail.