From 7c6cd9fba1f1aed2966c7cf12a03cd4f0840bd56 Mon Sep 17 00:00:00 2001 From: Midia Kiasat Date: Mon, 2 Mar 2026 20:20:47 +0100 Subject: [PATCH] docs: standardize readme baseline --- README.md | 70 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 91002fb..b9df818 100644 --- a/README.md +++ b/README.md @@ -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`.