Documentation Index

Documentation Index

A complete map of pqcrypto's documentation. The wiki pages (linked by name) are the friendly front door; the canonical, version-controlled documents live in the repository's doc/ directory and mirror the in-repo doc/INDEX.md.

Getting started

• Home — overview and 60-second quickstart.
• Installation — add the package, platforms, setup.
• Quickstart — ML-KEM, ML-DSA, HashML-DSA, and SLH-DSA in minutes.
• Cookbook — project ideas and reusable recipes.
• README — the pub.dev landing page.

Algorithms

• Cryptographic Algorithms — overview and comparison.
• ML-KEM (FIPS 203) — key encapsulation.
• ML-DSA (FIPS 204) — digital signatures.
• SLH-DSA (FIPS 205) — hash-based signatures.
• MLKEM_TESTING.md — ML-KEM KAT corpus and gates.
• MLDSA_FIPS204_RELEASE_GUIDE.md — ML-DSA implementation and validation.
• SLHDSA_FIPS205_RELEASE_GUIDE.md — SLH-DSA implementation and validation (all 12 sets).
• ALGORITHM_EXPANSION_GUIDE.md — future PQC directions.

Architecture and design

• Architecture and ARCHITECTURE.md — module layout and data flow.
• Design Philosophy — the tenets.
• Performance and PERFORMANCE.md — baseline and guidance.
• ENGINEERING_GUIDE.md — contributor setup and conventions.

Assurance: security, compliance, validation

• Security Posture and SECURITY_AUDIT.md — threat model and audit status.
• FIPS Compliance, FIPS_COMPLIANCE.md, and FIPS_140_BOUNDARY.md — claim boundary.
• Validation & Interoperability and OPENSSL_INTEROP.md — KAT and interop evidence.
• SECURITY.md — vulnerability disclosure.

Integration and tooling

• Serverpod & Flutter and SERVERPOD_FLUTTER_GUIDE.md — full client/server blueprint.
• Multi-Agent PQC Framework and UNIVERSAL_MULTI_AGENT_PQC_FRAMEWORK.md — agent planning framework.

Cookbook (in repository)

• Cookbook README
• Building Blocks
• Project Catalog
• Future Releases
• project-ideas.yaml (machine-readable, for AI agents)

Project and process

• Roadmap and ROADMAP.md
• PROGRESS_TRACKER.md, BUGS.md, IMPROVEMENTS.md
• FIPS202_SP800185_RELEASE_GUIDE.md — SHA-3 family workstream.
• Contributing, CONTRIBUTING.md, CODE_OF_CONDUCT.md
• CHANGELOG.md, RELEASE.md, LICENSE (MIT)

API reference

• pub.dev API docs — generated dartdoc, including the Cookbook topic.