Christian Nennemann
2e081ead8e
Rename all project references from quicproquo/qpq to quicprochat/qpc across documentation, Docker configuration, CI workflows, packaging scripts, operational configs, and build tooling. - Docker: crate paths, binary names, user/group, data dirs, env vars - CI: workflow crate references, binary names, artifact names - Docs: all markdown files under docs/, SDK READMEs, book.toml - Packaging: OpenWrt Makefile, init script, UCI config (file renames) - Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team - Operations: Prometheus config, alert rules, Grafana dashboard - Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths - Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
137 lines
4.2 KiB
Markdown
137 lines
4.2 KiB
Markdown
# Summary
|
|
|
|
[Introduction](introduction.md)
|
|
|
|
---
|
|
|
|
# Why quicprochat?
|
|
|
|
- [Comparison with Classical Chat Protocols](design-rationale/protocol-comparison.md)
|
|
- [Why This Design, Not Signal/Matrix/...](design-rationale/why-not-signal.md)
|
|
|
|
---
|
|
|
|
# Getting Started
|
|
|
|
- [Prerequisites](getting-started/prerequisites.md)
|
|
- [Building from Source](getting-started/building.md)
|
|
- [Running the Server](getting-started/running-the-server.md)
|
|
- [Running the Client](getting-started/running-the-client.md)
|
|
- [REPL Command Reference](getting-started/repl-reference.md)
|
|
- [Rich Messaging](getting-started/rich-messaging.md)
|
|
- [File Transfer](getting-started/file-transfer.md)
|
|
- [TLS in quicprochat](getting-started/tls.md)
|
|
- [Certificate Lifecycle and CA-Signed TLS](getting-started/certificate-lifecycle.md)
|
|
- [Docker Deployment](getting-started/docker.md)
|
|
- [Mesh Networking](getting-started/mesh-networking.md)
|
|
- [Demo Walkthrough: Alice and Bob](getting-started/demo-walkthrough.md)
|
|
|
|
---
|
|
|
|
# Architecture
|
|
|
|
- [Architecture Overview](architecture/overview.md)
|
|
- [Protocol Stack](architecture/protocol-stack.md)
|
|
- [Crate Responsibilities](architecture/crate-responsibilities.md)
|
|
- [Service Architecture](architecture/service-architecture.md)
|
|
- [End-to-End Data Flow](architecture/data-flow.md)
|
|
|
|
---
|
|
|
|
# Protocol Deep Dives
|
|
|
|
- [Protocol Layers Overview](protocol-layers/overview.md)
|
|
- [QUIC + TLS 1.3](protocol-layers/quic-tls.md)
|
|
- [Protobuf Framing](protocol-layers/capn-proto.md)
|
|
- [MLS (RFC 9420)](protocol-layers/mls.md)
|
|
- [Hybrid KEM: X25519 + ML-KEM-768](protocol-layers/hybrid-kem.md)
|
|
|
|
---
|
|
|
|
# Client SDKs
|
|
|
|
- [SDK Overview](sdk/index.md)
|
|
- [Wire Format Reference](sdk/wire-format.md)
|
|
- [Rust SDK](sdk/rust.md)
|
|
- [Go SDK](getting-started/go-sdk.md)
|
|
- [TypeScript SDK and Browser Demo](getting-started/typescript-sdk.md)
|
|
- [C FFI Bindings](getting-started/ffi.md)
|
|
- [WASM Integration](getting-started/wasm.md)
|
|
|
|
---
|
|
|
|
# Cryptographic Properties
|
|
|
|
- [Cryptography Overview](cryptography/overview.md)
|
|
- [Ed25519 Identity Keys](cryptography/identity-keys.md)
|
|
- [Key Lifecycle and Zeroization](cryptography/key-lifecycle.md)
|
|
- [Forward Secrecy](cryptography/forward-secrecy.md)
|
|
- [Post-Compromise Security](cryptography/post-compromise-security.md)
|
|
- [Post-Quantum Readiness](cryptography/post-quantum-readiness.md)
|
|
- [Threat Model](cryptography/threat-model.md)
|
|
|
|
---
|
|
|
|
# Wire Format Reference
|
|
|
|
- [Wire Format Overview](wire-format/overview.md)
|
|
- [Envelope Schema](wire-format/envelope-schema.md)
|
|
- [Auth Schema](wire-format/auth-schema.md)
|
|
- [Delivery Schema](wire-format/delivery-schema.md)
|
|
- [NodeService Schema](wire-format/node-service-schema.md)
|
|
|
|
---
|
|
|
|
# Design Rationale
|
|
|
|
- [Design Decisions Overview](design-rationale/overview.md)
|
|
- [ADR-002: Cap'n Proto over MessagePack](design-rationale/adr-002-capnproto.md)
|
|
- [ADR-004: MLS-Unaware Delivery Service](design-rationale/adr-004-mls-unaware-ds.md)
|
|
- [ADR-005: Single-Use KeyPackages](design-rationale/adr-005-single-use-keypackages.md)
|
|
- [ADR-006: SDK-First Adoption (No REST Gateway)](design-rationale/adr-006-rest-gateway.md)
|
|
|
|
---
|
|
|
|
# Implementation Internals
|
|
|
|
- [GroupMember Lifecycle](internals/group-member-lifecycle.md)
|
|
- [KeyPackage Exchange Flow](internals/keypackage-exchange.md)
|
|
- [Delivery Service Internals](internals/delivery-service.md)
|
|
- [Authentication Service Internals](internals/authentication-service.md)
|
|
- [Storage Backend](internals/storage-backend.md)
|
|
- [Server Hooks (Plugin System)](internals/server-hooks.md)
|
|
|
|
---
|
|
|
|
# Roadmap
|
|
|
|
- [Milestone Tracker](roadmap/milestones.md)
|
|
- [Phase 2 + M4-M6 Roadmap](roadmap/phase2-and-m4-m6.md)
|
|
- [Production Readiness WBS](roadmap/production-readiness.md)
|
|
- [Auth, Devices, and Tokens](roadmap/authz-plan.md)
|
|
- [1:1 Channel Design](roadmap/dm-channels.md)
|
|
- [Future Research Directions](roadmap/future-research.md)
|
|
- [Full Roadmap (Phases 1-8)](../../ROADMAP.md)
|
|
|
|
---
|
|
|
|
# Operations
|
|
|
|
- [Monitoring](operations/monitoring.md)
|
|
- [Backup and Restore](operations/backup-restore.md)
|
|
- [Scaling Guide](operations/scaling-guide.md)
|
|
|
|
---
|
|
|
|
# Contributing
|
|
|
|
- [Coding Standards](contributing/coding-standards.md)
|
|
- [Testing Strategy](contributing/testing.md)
|
|
|
|
---
|
|
|
|
# Appendix
|
|
|
|
- [Glossary](appendix/glossary.md)
|
|
- [References and Further Reading](appendix/references.md)
|