docs: rewrite README and add CHANGELOG

README: updated to reflect current product (FlowPilot, PSA integration,
Knowledge Flywheel), fixed stale roadmap references to closed issues,
corrected Tailwind version (v3→v4), added Quick Start section, linked
all documentation.

CHANGELOG: organized by version from v0.1.0 (Jan 2026) through v0.9.0
(current), covering all major features across 9 releases.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-03-21 16:26:52 +00:00
parent 8e2332bc51
commit a9717951f0
2 changed files with 223 additions and 110 deletions

139
CHANGELOG.md Normal file
View File

@@ -0,0 +1,139 @@
# Changelog
All notable changes to ResolutionFlow are documented here.
## [Unreleased]
### Added
- Tree Templates + Import/Export marketplace (#66)
- Recurring Issue Detection — client-specific pattern alerts (#60)
- Step Feedback Flag — "This Step is Wrong" reporting (#58)
---
## [0.9.0] - 2026-03-21
### Added
- **Landing page design audit** — mobile hamburger menu, Privacy and Terms pages, responsive modals
- **Mobile search collapse** — TopBar search bar collapses to magnifying glass icon on mobile
- **Root directory cleanup** — archived 9 completed docs, tracked marketing assets and dev environment guide
### Changed
- Branding updated: "Decision Tree Platform" → "AI-Powered Troubleshooting for MSPs" on login, register, HTML title
- Section spacing tightened on landing page, heading hierarchy fixed (div → h2)
- Register page icon fixed from red/coral to cyan brand color
- `transition: all` replaced with specific properties across landing CSS
- `color-scheme: dark` added to HTML element
- GitHub issues triaged: closed 10 stale issues (6 completed, 4 deferred), 3 remain open
---
## [0.8.0] - 2026-03-20
### Added
- **FlowPilot cockpit dashboard** — quick-start input, active sessions, pending escalations, performance cards, knowledge base cards, team summary
- **Sidebar redesign** — Dashboard → Resolve → Knowledge → Insights hierarchy with collapsible sections
- **Search & Recall** — PostgreSQL FTS on AI sessions, Command Palette integration (Ctrl+K), structured filters
- **Semantic similar sessions** — Voyage AI embeddings for finding related past sessions in FlowPilot sidebar
- **Evidence-rich sessions** — RichTextInput with clipboard paste, S3 file upload/download API
- **Navigation guard** — `useBlocker` warns before leaving active FlowPilot sessions
### Fixed
- FlowPilot action bar height chain (Resolve/Escalate/Pause buttons disappearing)
- `InFailedSQLTransaction` cascade from `get_db` missing rollback
- Session detail 500 errors from serialization issues
- Escalation fallback when `team_id` is null
- CORS middleware returning proper responses instead of re-raising
---
## [0.7.0] - 2026-03-19
### Added
- **Phase 5 Analytics Enhancement** — flow coverage heatmap, quality scoring, PSA activity logging, enhanced metrics
- **Phase 4 Enterprise features** — public templates gallery, admin curation, branded exports, custom branding (logo, accent, company name), multi-PSA adapter stubs (Autotask, Halo), SSO/SAML groundwork
- **Notification system** — multi-channel (in-app, email) with preferences and batch digest
### Fixed
- Analytics domain matching, funnel counts, decimal casts
- Frontend routing, accessibility, error states, sort indicators
---
## [0.6.0] - 2026-03-18
### Added
- **FlowPilot Phase 1** — AI-powered troubleshooting sessions with guided multi-step engine, copilot panel, confidence-tiered model routing
- **FlowPilot Phase 2** — ConnectWise PSA integration (ticket linking, note posting, member mapping), escalation handoff with AI-enhanced briefing, session pause/resume, mid-session ticket linking
- **Knowledge Flywheel (Phase 3)** — AI session analysis → automatic flow proposals, review queue (approve, edit & publish, dismiss, reject), knowledge gap detection, FlowPilot analytics dashboard, APScheduler batch analysis
---
## [0.5.0] - 2026-03-16
### Added
- **Security headers** — CSP (report-only), HSTS, X-Content-Type-Options, X-Frame-Options
- **Coverage gates** — 80% backend coverage enforced in CI, frontend coverage reporting
- **Core Web Vitals** — LCP, FID, CLS reporting to PostHog
- **PostHog analytics** — event tracking across all key user actions, user identification, autocapture
- **Playwright e2e tests** — coverage for new features and uncovered workflows
- **Command palette** — global search (Ctrl+K) with fuzzy matching across flows, sessions, tags
---
## [0.4.0] - 2026-03-14
### Added
- **ConnectWise PSA integration design** — provider abstraction, encrypted credentials, ticket context
- **Script Generator** — backend engine, API, frontend template editor, parameter detector
- **Procedural editor validation** — validation summary with click-to-select and Fix with AI
- **Landing page** — marketing site with beta signup, pricing tiers, product preview mockup
---
## [0.3.0] - 2026-03-03
### Added
- **Slate & Ice design system** — dark glassmorphism, ice-cyan gradient accents, glass-card system, orchestrated animations
- **Tailwind CSS v4 migration** — CSS-only config, `@tailwindcss/vite` plugin
- **KB Accelerator** — convert knowledge base articles into interactive flows
- **AI chat conclusion** — outcome tracking, AI-generated ticket summaries, resume flow
- **Survey system** — public survey page, admin invite tracking, response viewer with CSV export
- **Email verification** — tokens, banner, admin toggle
- **AI assistant** — in-session copilot panel, standalone chat with RAG, prompt caching
- **Sentry error monitoring** — frontend and backend integration
- **Flexible intake** — deferred variables, prepared sessions
- **Session closure** — close from history page with inline popover
- **Shared Modal enforcement** — standardized modal component across codebase
### Fixed
- Race condition hardening across auth, counters, and data fetching
- MissingGreenlet crash in AI Assistant
---
## [0.2.0] - 2026-02-10
### Added
- **Flow Editor** — form-based with visual canvas preview (React Flow + dagre), undo/redo
- **Procedural Flows** — step-by-step checklists with section headers, collapsible fields
- **Maintenance Flows** — scheduled recurring tasks with batch execution
- **AI Flow Builder** — conversational AI generates complete flows from description
- **Step Library** — shared reusable steps with ratings, reviews, verified-use badges
- **Session features** — timer, keyboard shortcuts, scratchpad overlay, auto-recovery, sharing
- **Organization** — categories, tags, folders (3-level), full-text search, grid/list/table views
- **Admin Panel** — 8 pages (dashboard, users, invite codes, audit logs, plan limits, feature flags, settings, categories)
- **Account management** — profile settings, delete/leave/transfer, chat retention
- **Export** — Markdown, text, HTML with detail levels, editable preview, redaction
---
## [0.1.0] - 2026-01-15
### Added
- Initial release: FastAPI backend with JWT auth, PostgreSQL database
- Trees and Sessions CRUD APIs
- Export functionality (Markdown, Text, HTML)
- React frontend with TypeScript
- Railway deployment with auto-deploy on push to main
- Invite code registration system for beta