Skip to content

Latest commit

 

History

History
299 lines (229 loc) · 8.93 KB

PROJECT-OVERVIEW.md

File metadata and controls

299 lines (229 loc) · 8.93 KB

EmberDocs - Complete Documentation Package

Created: December 2025
Status: Ready for Development
License: Core (proprietary, source-available)

📦 Package Contents

This folder contains everything you need to build EmberDocs, a modern documentation framework with Git-native versioning, instant search, and developer-focused design.

📂 Folder Structure

emberdocs-complete/
├── README.md                          # This file - start here
├── docs/                              # Example documentation (user-facing)
│   └── examples/                     # Sample docs for testing/demonstration
├── dev-docs/                          # Developer documentation
│   ├── specs/                        # Technical specifications
│   │   ├── EMBERDOCS-TECHNICAL-SPEC.md
│   │   ├── EMBERDOCS-DATABASE-SCHEMA.md
│   │   ├── EMBERDOCS-API-SPEC.md
│   │   └── EMBERDOCS-ROADMAP.md
│   ├── guides/                       # Development guides
│   │   ├── ARCHITECTURE-DECISIONS.md
│   │   ├── DEVELOPMENT-STANDARDS.md
│   │   ├── DEV-SETUP-VERIFICATION.md
│   │   └── FEATURE-DEPENDENCIES.md
│   ├── planning/                     # Phase plans
│   ├── progress/                     # Daily progress logs
│   ├── PROJECT-OVERVIEW.md           # This file
│   ├── USER-STORIES.md                # User personas
│   ├── EMBERDOCS-LICENSING.md        # Licensing model
│   ├── ACCESSIBILITY-AUDIT.md        # Accessibility audit
│   ├── Setup.md                      # Installation guide
│   ├── Deployment.md                 # Deployment guide
│   └── Quick-Reference.md            # Developer cheat sheet
├── brand/                             # Brand identity & design system
│   ├── emberdocs-brand-guidelines.md
│   └── EMBERDOCS-STYLE-GUIDE.md
├── mockups/                           # Visual mockups
│   ├── landing/                       # Marketing landing pages
│   │   ├── LANDING-MOCKUPS-GUIDE.md
│   │   ├── landing-mockup-01-minimal.html
│   │   ├── landing-mockup-02-developer-dark.html
│   │   └── landing-mockup-03-feature-grid.html
│   └── ui/                            # Application UI screens
│       ├── UI-MOCKUPS-GUIDE.md
│       ├── ui-mockup-01-documentation-page.html
│       ├── ui-mockup-02-search-modal.html
│       ├── ui-mockup-03-mobile-navigation.html
│       ├── ui-mockup-04-version-switcher.html
│       └── ui-mockup-05-component-library.html
└── logos/                             # Logo assets
    ├── emberdocs-v2-02-stacked-pages-light.png
    ├── emberdocs-v2-02-stacked-pages-dark.png
    ├── emberdocs-v2-icon-06-minimal-flame.png
    ├── emberdocs-v2-05-forward-chevron-light.png
    └── emberdocs-v2-05-forward-chevron-dark.png

🚀 Quick Start Guide

1. Understand the Vision

Start with the technical spec to understand what you're building.

2. Review Technical Architecture

Read in this order:

  1. dev-docs/specs/EMBERDOCS-TECHNICAL-SPEC.md - Complete technical overview
  2. dev-docs/specs/EMBERDOCS-DATABASE-SCHEMA.md - Data models and storage
  3. dev-docs/specs/EMBERDOCS-API-SPEC.md - API endpoints and contracts

3. Understand the Design

  1. brand/EMBERDOCS-STYLE-GUIDE.md - Colors, typography, components
  2. mockups/ui/UI-MOCKUPS-GUIDE.md - Application screen designs
  3. Open the HTML mockups in your browser to see the UI

4. Plan Development

  1. dev-docs/specs/EMBERDOCS-ROADMAP.md - 16-week development timeline
  2. dev-docs/EMBERDOCS-LICENSING.md - Licensing model details

5. Start Building

Use the mockups and technical specs to begin implementation.

📋 Complete Document Index

Technical Documentation (/dev-docs)

specs/EMBERDOCS-TECHNICAL-SPEC.md (28KB)

  • Product overview and philosophy
  • Core features and capabilities
  • Technology stack (Next.js, TypeScript, PostgreSQL, FlexSearch)
  • System architecture
  • File structure and organization
  • CLI tool design
  • Performance targets (<50ms search, <1s builds)

specs/EMBERDOCS-DATABASE-SCHEMA.md (26KB)

  • PostgreSQL schema with Prisma ORM
  • Multi-tenancy support
  • Privacy-first analytics
  • Complete table definitions
  • Indexes and relationships

specs/EMBERDOCS-API-SPEC.md (17KB)

  • REST and GraphQL endpoints
  • Authentication (API keys, JWT)
  • Content management APIs
  • Search API integration
  • Webhook system

specs/EMBERDOCS-ROADMAP.md (18KB)

  • 16-week development timeline
  • Phase 1: Core Framework (Weeks 1-4)
  • Phase 2: Search & Navigation (Weeks 5-8)
  • Phase 3: Advanced Features (Weeks 9-12)
  • Phase 4: Polish & Launch (Weeks 13-16)

EMBERDOCS-LICENSING.md (11KB)

  • Core: proprietary source-available license (see LICENSE)
  • What users CAN and CANNOT do
  • FAQ and use cases

Brand & Design (/brand)

emberdocs-brand-guidelines.md (14KB)

  • Logo usage and variations
  • Color palette (purple #8B5CF6, amber #F59E0B)
  • Typography (Inter, JetBrains Mono)
  • Voice and tone
  • Brand personality

EMBERDOCS-STYLE-GUIDE.md (22KB)

  • Complete design system
  • Logo system specifications
  • Typography and type scale
  • Color system (light and dark modes)
  • Spacing, layout, shadows
  • UI component specs
  • Animation guidelines
  • Accessibility standards (WCAG 2.1 AA)

Mockups (/mockups)

Landing Pages (/mockups/landing)

LANDING-MOCKUPS-GUIDE.md

  • Overview of 3 landing page variations
  • Comparison matrix and recommendations

landing-mockup-01-minimal.html

  • Clean, spacious, focused design
  • Simple hero + 6-feature grid

landing-mockup-02-developer-dark.html ⭐ RECOMMENDED

  • Full dark theme with terminal animation
  • Stats section + comparison table
  • Tech stack badges

landing-mockup-03-feature-grid.html

  • Large numbered feature cards
  • Comprehensive feature showcase

UI Screens (/mockups/ui)

UI-MOCKUPS-GUIDE.md

  • Complete UI implementation guide
  • Component specifications
  • Responsive breakpoints
  • 8-week implementation roadmap

ui-mockup-01-documentation-page.html ⭐ CORE

  • 3-column layout (sidebar, content, TOC)
  • Code blocks with syntax highlighting
  • Fully responsive

ui-mockup-02-search-modal.html

  • ⌘K instant search
  • Keyboard navigation
  • Recent searches

ui-mockup-03-mobile-navigation.html

  • Hamburger menu with drawer
  • Bottom navigation
  • Touch-optimized

ui-mockup-04-version-switcher.html

  • Version list with badges
  • Inline changelogs
  • Comparison tools

ui-mockup-05-component-library.html

  • Complete design system showcase
  • All UI components
  • Developer reference

Logos (/logos)

emberdocs-v2-02-stacked-pages-light.png (1200×1200px)

  • Primary logo for light backgrounds

emberdocs-v2-02-stacked-pages-dark.png (1200×1200px)

  • Primary logo for dark backgrounds

emberdocs-v2-icon-06-minimal-flame.png (256×256px)

  • Icon/favicon logo

emberdocs-v2-05-forward-chevron-light.png (1200×1200px)

  • Accent logo for navigation

emberdocs-v2-05-forward-chevron-dark.png (1200×1200px)

  • Accent logo for dark backgrounds

🎯 Key Features

  • Git-Native Versioning - Automatic version detection from Git tags
  • Instant Search - <50ms FlexSearch with keyboard shortcuts
  • Dark Theme - Developer-focused dark UI
  • Mobile-First - Touch-optimized responsive design
  • Zero Config - 2-minute setup time
  • Privacy-First - No third-party trackers
  • Free Forever - Core framework free to self-host

🛠 Technology Stack

Frontend: Next.js 16+, TypeScript 5+, Tailwind CSS 3+
Backend: PostgreSQL 14+, Prisma, Redis (optional)
Search: FlexSearch (client-side)
Deployment: Vercel, Netlify, self-hosted

📊 Performance Targets

  • Search: <50ms response
  • Initial Load: <1s to interactive
  • Build: <1s per page
  • Lighthouse: 100/100/100/100

🔐 Licensing

Core Framework: Proprietary source-available license (see LICENSE)
Hosted Service: Proprietary (optional premium offering)

📈 Development Phases

Phase 1 (Weeks 1-4): Foundation - markdown parsing, routing
Phase 2 (Weeks 5-8): Search - FlexSearch integration, ⌘K UI
Phase 3 (Weeks 9-12): Features - versioning, mobile nav
Phase 4 (Weeks 13-16): Polish - optimization, launch

✅ What's Included

  • Complete technical specifications
  • Database schema and API design
  • 16-week development roadmap
  • Brand guidelines and style guide
  • Logo assets (5 variations)
  • 3 landing page mockups (HTML)
  • 5 UI screen mockups (HTML)
  • Component library reference
  • Licensing documentation

🎯 Next Steps

  1. Read dev-docs/specs/EMBERDOCS-TECHNICAL-SPEC.md
  2. Browse UI mockups in mockups/ui/
  3. Review dev-docs/specs/EMBERDOCS-ROADMAP.md
  4. Start building!

Ready to build? All the documentation you need is in this folder. 🚀