Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 3.61 KB

File metadata and controls

129 lines (94 loc) · 3.61 KB

📚 Chapters Documentation

Everything you need to understand, build, and deploy Chapters.


📖 Core Documents

Product & Philosophy

  • Vision - Product philosophy, manifesto, glossary, and copy guidelines
  • Visual Design - Design system, colors, typography

Development

  • Requirements - 200+ feature specifications
  • Design - System architecture and data models
  • Tasks - Implementation plan and progress
  • Testing - Testing strategy and correctness properties
  • Setup Guide - Local development setup

Features

  • Gamification - Muse levels and quiet badges
  • Muse - AI companion philosophy and abilities

Deployment


🚀 Quick Start

New to Chapters?

  1. Read Vision - understand the philosophy (includes glossary and copy guidelines)
  2. Review Visual Design - see the design system
  3. Check Web Version - explore web platform capabilities
  4. Follow Setup Guide - get running locally

Building features?

Deploying?


🎨 Design Philosophy

Three core principles:

  1. Calm over Stimulation - No infinite scroll, no dopamine traps
  2. Depth over Speed - Quality content, thoughtful sharing
  3. Privacy First - Everything starts private

Every feature, color, and interaction follows these principles.


📚 Feature Glossary (Quick Reference)

User Identity:

  • Book - Your profile (not "account")
  • Inside Flap - Your bio (not "about")
  • Bindings - Account security (password)

Content:

  • Chapter - A post (not "update")
  • Open Page - Daily publishing allowance
  • Study - Private workspace for drafts

Discovery:

  • Library - Main view (not "feed")
  • Spines - People discovery through work
  • Quiet Picks - Daily AI recommendations
  • Shelf - Curated collection of Books

Engagement:

  • Heart - Appreciate a chapter (Soft Sage, not red)
  • Bookmark - Save for later
  • Margins - Comments (hidden by default)
  • Between the Lines - Private 1:1 conversations

See Vision for complete terminology guide.


📊 Project Stats

  • Requirements: 200+ specifications
  • Tasks: 41 (41 complete)
  • Tests: 70+ passing
  • API Endpoints: 50+
  • Features: 12 complete (including web full feature parity)
  • Status: Production ready, all core features complete

📝 Documentation Standards

Writing Style

  • Use clear, concise language
  • Follow the book/library metaphor
  • Be technically accurate
  • Include code examples where relevant

Requirements Format

Requirements use the EARS pattern:

WHEN [trigger/condition]
THE System SHALL [action/behavior]

Copy Tone

All user-facing copy should be:

  • Literary - Use book/library metaphors
  • Calm - No urgency, no exclamation points
  • Brief - Short and sweet
  • Respectful - Acknowledge user autonomy
  • Honest - No marketing speak

See Vision for complete copy guidelines and empty state examples.


Take your time exploring. 📖