Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 46 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,46 @@
# VERIFRAX DOCUMENTATION

AUTHORITATIVE EXPLANATIONS OF THE VERIFRAX SYSTEM.

THIS REPO:
- EXPLAINS (NOT DEFINES)
- REFERENCES SPEC AND PROFILES
- NEVER OVERRIDES CONTRACTS

---
AUTHORITATIVE LINKS:
- SPEC: https://github.com/Verifrax/VERIFRAX-SPEC
- PROFILES: https://github.com/Verifrax/VERIFRAX-PROFILES
- VERIFIER: https://github.com/Verifrax/VERIFRAX-verify

## Contract
- stable permalinks
- SPEC-anchored normative references
- minimal + deterministic build pipeline

## Core links
- SPEC: https://github.com/Verifrax/VERIFRAX-SPEC
- PROFILES: https://github.com/Verifrax/VERIFRAX-PROFILES
- Engine: https://github.com/Verifrax/VERIFRAX
# VERIFRAX-DOCS

## Purpose

Public documentation site for the Verifrax stack.

## Status

- **Stability**: Experimental
- **SemVer**: Not guaranteed until v1.0.0
- **Security**: See **Security** section below

## Scope

- What this repo is responsible for
- What it explicitly does **not** do

## Quickstart

```bash
# clone
git clone https://github.com/Verifrax/VERIFRAX-DOCS.git
cd VERIFRAX-DOCS

# install (adjust if needed)
# (placeholder) npm install / pnpm install / go test ./... / etc.
```

## Repository layout

- `/` Root sources
- `/.github/` Issue + PR templates
- `/docs/` Documentation (if present)

## Security

- Report vulnerabilities privately: **security@verifrax.org**
- Do **not** open public issues for sensitive findings

## Contributing

See `CONTRIBUTING.md`.

## License

MIT. See `LICENSE`.