README.md

ProofLog Documentation

This directory holds public project documentation for ProofLog.

Keep docs small and current. If a document does not help a user install, operate, contribute to, release, or understand ProofLog, prefer removing it or moving the detail into tests, CLI help, or code comments.

User Docs

• Installation
• CLI behavior
• Demo script
• Changelog

Contributor Docs

• Contributing
• Parser fixtures
• Release checklist

Design Docs

• Product requirements
• Architecture
• Roadmap
• Risk register
• Operating model

Current Repository State

ProofLog currently includes the Rust CLI, local config, SQLite storage, doctor checks, Codex JSONL ingestion, parser diagnostics, git correlation, verification/failure/risk classification, report redaction, text/Markdown/experimental JSON proof reports, and decision-based exit codes.

Decision Rule

If a proposed change does not make prooflog proof --since main more trustworthy, faster, clearer, or easier to adopt, defer it.