FlowDock

Documentation-first, local-first adaptive workspace platform.

FlowDock helps people continue their current work with less friction by keeping the most relevant information, tools, and actions within reach.

Project Status

v0.1.0 — MVP released with CD-02 Recovery Anchor and CD-03 Active-Work Companion.

| Level | Phase | Status | |-------|-------|--------| | 0–7 | Governance → Implementation | ✓ Complete | | 8 | Validation | ✓ PASS WITH DEBT — 46/55 evidence | | 9 | Open Source Release | ✓ PASS WITH DEBT — release ready |

Implementation: 144 tests passing (23 files), typecheck passing. CD-02 Recovery Anchor (idle/lock → auto-interrupt → recovery notification). CD-03 Active-Work Companion (live panel).

Quick Start

git clone https://github.com/bayanmunkh-com/flowdock.git
cd flowdock
pnpm install
pnpm build

# Record work context
pnpm cli:run focus "Your task"
pnpm cli:run record info "Notes"
pnpm cli:run record tool "VS Code"
pnpm cli:run record action "Next step"

# View
pnpm cli:run view
pnpm cli:run panel watch   # CD-03: live companion panel
pnpm cli:run status

# Recovery anchor (CD-02)
pnpm watch &               # auto-interrupt on idle/screen lock
./install.sh               # systemd auto-start on login

# After interruption
pnpm cli:run recover

Development

FlowDock uses pnpm as its package manager. Node.js 18+ required.

pnpm install
pnpm build
pnpm test        # 144 tests
pnpm typecheck   # strict TypeScript
pnpm cli:run status

Vision

FlowDock augments existing workflows.

It does not replace existing tools.

Its purpose is to reduce workflow interruption by continuously surfacing the most relevant context for the user's current work.

Development Process

FlowDock follows a documentation-first development process.

Every major decision follows the approved project workflow:

| Level | Phase | |-------|-------| | 0 | Project Governance | | 1 | Product Discovery | | 2 | Product Definition | | 3 | Product Planning | | 4 | Architecture | | 5 | Repository Design | | 6 | Iteration Planning | | 7 | Implementation | | 8 | Validation | | 9 | Open Source Release |

The canonical development workflow is defined in:

• Development Process

Repository Structure

docs/
├── process/
├── product/
│   └── iteration-3/    # CD-02, CD-03
├── architecture/
├── adr/
├── repository/
├── iteration/
├── validation/
└── reviews/

Documentation

Process

• Development Process

Product

• Problem Statement
• Vision
• Target Users
• User Personas
• Existing Solutions
• Value Proposition
• User Stories
• MVP Scope
• Product Requirements Document (PRD)

Architecture

• Architecture Plan
• Core Concepts
• System Context
• Domain Boundaries
• Information Model

Architecture Decision Records

• ADR-001 — System Boundary Constraints for MVP
• ADR-002 — Single Work Context Architectural Domain
• ADR-003 — Acquire–Retain–Deliver Capability Model
• ADR-004 — Information Model of the Work Context Domain

Repository Design

• Repository Design Plan
• Repository Structure
• Documentation Structure
• Development Conventions

Iteration Planning

• Iteration Planning Plan
• Iteration Strategy
• Iteration Goals
• Epics
• Tasks
• Level 6 Review Gate

Validation

• Validation Plan
• Validation Scenarios
• Requirement Traceability
• Validation Evidence
• Level 8 Review Gate
• Validation Evidence Records
• Validation Progress

Iteration 3 (CD-02, CD-03)

• CD-02 Recovery Anchor — PRD
• CD-03 Active-Work Companion

Release

• Release Notes
• Contributing
• Changelog

Reviews

• Level 7 Architecture Review
• Level 9 Release Readiness Review
• Technical Debt Register

License

This project is licensed under the Apache License 2.0.

See the LICENSE file for details.