Files
cairnquire/.project/README.md

3.9 KiB

Cairnquire - Documentation Index

Project Planning

Document Description
project-plan.md Master project plan with milestones, timelines, and acceptance criteria
architecture-overview.md System architecture, component diagrams, and data flow

Architecture Decision Records (ADRs)

Document Decision
ADR-001: Tech Stack Go server with embedded web assets
ADR-002: Sync Protocol SimpleSync content-addressed protocol
ADR-003: SSR Strategy Go templates with embedded browser scripts
ADR-004: Auth Strategy Passkeys primary, passwords fallback
ADR-005: Storage Strategy libsql + content-addressed filesystem
ADR-006: Email Strategy Postmark gateway, plain-text only
ADR-007: Security Model Defense in depth, minimal dependencies

Milestones

Document Duration Focus
Milestone 1: Foundation Weeks 1-2 Server, database, markdown rendering
Milestone 2: Sync Protocol Weeks 3-4 File sync, offline support, WebSocket
Milestone 3: Authentication Weeks 5-6 Passkeys, sessions, RBAC
Milestone 4: Collaboration Weeks 7-8 Comments, email, conflict resolution
Milestone 5: Search & UI Weeks 9-10 Full-text search, design system, responsive
Milestone 6: Production Weeks 11-12 Testing, security audit, ops docs

Technical Specifications

Document Topic
SimpleSync Protocol Message formats, state machine, security
Security Specification Threat model, controls, implementation
Deployment Guide Docker setup, configuration, operations

Key Metrics

  • Timeline: 12 weeks (3 months)
  • Test Coverage Target: >80%
  • Performance Targets:
    • Initial page load: <100ms
    • Search query: <50ms
    • File sync: <5s
  • Security: Zero critical/high vulnerabilities
  • Dependencies: Minimal, all pinned and audited

Next Steps

  1. Review all documentation
  2. Approve project plan
  3. Set up repository and CI pipeline
  4. Begin Milestone 1: Foundation

Project Structure

cairnquire/
├── docs/
│   ├── README.md (this file)
│   ├── project-plan.md
│   ├── architecture-overview.md
│   ├── adrs/
│   │   ├── adr-001-tech-stack.md
│   │   ├── adr-002-sync-protocol.md
│   │   ├── adr-003-ssr-strategy.md
│   │   ├── adr-004-auth-strategy.md
│   │   ├── adr-005-storage-strategy.md
│   │   ├── adr-006-email-strategy.md
│   │   └── adr-007-security-model.md
│   ├── milestones/
│   │   ├── milestone-01-foundation.md
│   │   ├── milestone-02-sync-protocol.md
│   │   ├── milestone-03-authentication.md
│   │   ├── milestone-04-collaboration.md
│   │   ├── milestone-05-search-ui.md
│   │   └── milestone-06-production.md
│   └── specs/
│       ├── simplesync-protocol.md
│       ├── security-specification.md
│       └── deployment-guide.md
├── apps/
│   └── server/          # Go application, templates, and static assets
├── packages/
│   └── protocol/        # Shared types
├── docker-compose.yml
├── Dockerfile
└── mise.toml