Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/performance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
- name: Check bundle size limits
run: |
BUNDLE_SIZE=$(du -sb dist/ | cut -f1)
MAX_SIZE=5242880 # 5MB limit (realistic for feature-rich React app)
MAX_SIZE=6291456 # 6MB limit (includes docs markdown assets)

if [ $BUNDLE_SIZE -gt $MAX_SIZE ]; then
echo "❌ Bundle size $BUNDLE_SIZE exceeds limit $MAX_SIZE"
Expand Down
221 changes: 149 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,112 +1,189 @@
<div align="center">

# VSPEC

> AI-Powered Documentation Platform with GitBook-Style Design
### The Documentation Scope for AI Era

**VSPEC** is a lightweight SaaS documentation platform featuring AI-driven document review, narrative integration, quality acceptance, and automatic structure analysis. Built with a restrained, authoritative design philosophy.
**AI is the gun, VSPEC is the scope.**
Without VSPEC, AI shoots blind; with VSPEC, every shot hits the target.

## ✨ Features
[![React](https://img.shields.io/badge/React-18.3-61DAFB?style=flat-square&logo=react&logoColor=white)](https://react.dev)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://typescriptlang.org)
[![Vite](https://img.shields.io/badge/Vite-6-646CFF?style=flat-square&logo=vite&logoColor=white)](https://vitejs.dev)
[![Tailwind](https://img.shields.io/badge/Tailwind_CSS-4.0-06B6D4?style=flat-square&logo=tailwindcss&logoColor=white)](https://tailwindcss.com)
[![License](https://img.shields.io/badge/License-Proprietary-7C85ED?style=flat-square)](#license)

- **AI Document Review (APE v1.1)** - Automated error detection, narrative optimization, and quality validation
- **Document Structure Analysis** - Auto-generated structure graphs and cluster maps
- **Real-time Collaboration** - Multi-user editing with live sync
- **GitBook-Style Editor** - Clean, distraction-free writing experience with right-click menus and manual editing modes
- **Eye-care Theme System** - Multiple reading modes optimized for long-form content
- **VDID Authentication** - Decentralized identity login integration
- **Command Center Dashboard** - Real-time monitoring with governance workflows
---

## 🎨 Design System
*Obsidian (Local-first) + GitBook (Publishing) + AI (Automation)*

- **Brand Color**: `#7C85ED` (Medium-saturation blue-purple) - Used sparingly for emphasis
- **Typography**: Space Grotesk font system
- **Background**: `#FAFAFA` with pure white cards and subtle shadows
- **Philosophy**: Restrained, professional design - no marketing fluff or gradients
- **Icons**: Direct display without background containers, grayscale with strategic brand color accents
- **πŸ”’ Text Visibility**: ENFORCED - No opacity on text elements ([Details](./TEXT_VISIBILITY_RULES.md))
[Live Demo](https://vspec.pub) &nbsp;&middot;&nbsp; [Documentation](https://vspec.pub/docs) &nbsp;&middot;&nbsp; [Pricing](https://vspec.pub/pricing)

## πŸ—οΈ Tech Stack
</div>

- **Frontend**: React + TypeScript
- **Styling**: Tailwind CSS v4.0
- **Routing**: React Router
- **State Management**: React Hooks
- **Icons**: Lucide React
- **Build Tool**: Vite
---

## πŸ“¦ Installation
## Why VSPEC?

Knowledge workers spend **9.3 hours per week** on documentation. VSPEC cuts that in half with AI-powered automation that delivers **20x ROI** at $0.40/day.

| Problem | VSPEC Solution |
|---------|---------------|
| Manual proofreading takes hours | **One-click Fix** - AI corrects grammar, style, and structure instantly |
| Processing 100+ docs is impossible | **Batch Processing** - Drag a folder, process everything automatically |
| Inconsistent terminology across docs | **Terminology Engine** - Maintains professional consistency throughout |
| Docs in one language limits reach | **7 Languages** - CN, EN, JP, KR, FR, DE, ES with native-quality output |
| No visibility into doc quality | **Structure Analysis** - Auto-generated structure graphs and quality scores |

## Core Features

**AI Document Intelligence**
- One-click fix: grammar, style, structure, and flow optimization
- Batch processing for bulk document operations
- Real-time AI suggestions as you write
- Automatic structure analysis and visualization

**Editor & Publishing**
- GitBook-style distraction-free editor with markdown support
- Command palette (`Cmd+K`) - reach any feature in 2 keystrokes
- One-click publishing to `yourname.vspec.pub`
- Export to PDF, DOCX, HTML, Markdown, and JSON

**Collaboration**
- Real-time multi-user editing with live cursors
- Comments, annotations, and approval workflows
- Role-based access control (Owner / Editor / Commenter / Viewer)
- Team workspaces with project isolation

**Platform**
- VDID decentralized identity authentication
- Eye-care theme system (Light / Sepia / Soft Dark)
- Fully responsive: desktop, tablet, and mobile
- PWA support for offline access
- GitHub / GitLab integration for docs-as-code

## Ecosystem

VSPEC is part of the **Velon** product ecosystem:

| Product | Description | Link |
|---------|-------------|------|
| **VELON** | Ecosystem hub | [velon.one](https://velon.one) |
| **VDID** | Decentralized identity | [vdid.io](https://vdid.io) |
| **VWORK** | Workspace platform | [velon.work](https://velon.work) |
| **RTPX** | Real-time protocol exchange | [rtpx.io](https://rtpx.io) |
| **VELGOO** | Discovery engine | [velgoo.cc](https://velgoo.cc) |
| **VSPEC** | Documentation OS | [vspec.pub](https://vspec.pub) |

## Tech Stack

| Layer | Technology |
|-------|-----------|
| Framework | React 18 + TypeScript |
| Build | Vite 6 with esbuild |
| Styling | Tailwind CSS v4 + Emotion |
| Routing | React Router v7 |
| State | Zustand + Immer |
| UI Components | Radix UI + Material UI |
| Rich Editor | Tiptap 3 |
| Animation | Motion (Framer Motion) |
| AI Backend | Multi-model (cost-optimized token routing) |
| Auth | Supabase + VDID OAuth 2.0 |
| i18n | i18next |

## Quick Start

```bash
# Clone repository
git clone https://github.com/Vleonone/VSPEC.git
cd VSPEC

# Install dependencies
npm install
pnpm install

# Start development server
npm run dev
pnpm dev
```

Open [http://localhost:5173](http://localhost:5173) in your browser.

```bash
# Build for production
npm run build
pnpm build

# Preview production build
pnpm preview

# Run tests
pnpm test
```

## πŸ“ Project Structure
## Project Structure

```
vspec/
VSPEC/
β”œβ”€β”€ docs/ # Markdown documentation (auto-synced to /docs page)
β”‚ β”œβ”€β”€ guides/ # Quick start & usage guides
β”‚ β”œβ”€β”€ internal/ # Internal strategy & planning docs
β”‚ └── *.md # Architecture, specs, whitepapers
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ app/
β”‚ β”‚ β”œβ”€β”€ components/ # Reusable UI components
β”‚ β”‚ β”œβ”€β”€ pages/ # Page components
β”‚ β”‚ └── App.tsx # Main app entry
β”‚ β”œβ”€β”€ assets/ # Static assets (illustrations, logos)
β”‚ β”œβ”€β”€ lib/ # Utilities and API helpers
β”‚ └── styles/ # Global styles and theme
β”œβ”€β”€ public/ # Public assets
└── package.json
β”‚ β”‚ β”œβ”€β”€ components/ # Reusable UI components
β”‚ β”‚ β”œβ”€β”€ hooks/ # Custom React hooks
β”‚ β”‚ β”œβ”€β”€ pages/ # Page components (lazy-loaded)
β”‚ β”‚ β”œβ”€β”€ stores/ # Zustand state stores
β”‚ β”‚ └── utils/ # Utilities & helpers
β”‚ β”œβ”€β”€ lib/ # API clients, auth, storage
β”‚ └── assets/ # Static assets
β”œβ”€β”€ public/ # Public assets & PWA manifest
└── vite.config.ts # Vite configuration
```

## πŸš€ Core Pages

- **Landing Page** (`/`) - Hero section with Spline 3D background
- **Dashboard** (`/dashboard`) - Command center with real-time monitoring
- **Editor** (`/editor`) - Full-featured document editor with structure graph
- **Login/Signup** - VDID integration for decentralized authentication

## 🎯 Key Components

### Editor Features
- Document tree with hierarchical indicators
- Right-click context menus
- Auto-structure graph visualization
- Real-time collaboration panel
- Manual editing mode toggle
## Documentation

### Dashboard Features
- Global Freshness Orb (Trust Score visualization)
- Ingestion Heatmap (Activity tracking)
- Governance Queue (Conflict management)
- Cluster Map (Document relationships)
Full documentation is available at [/docs](https://vspec.pub/docs) and is automatically generated from the `docs/` directory. Key references:

## πŸ“š Documentation

For detailed documentation, see:
- [Product Specification](./docs/PRODUCT-SPEC.md)
- [Architecture Guide](./docs/ARCHITECTURE.md)
- [AI Strategy](./docs/AI-STRATEGY.md)
- [Whitepaper (EN)](./docs/WHITEPAPER_EN.md) / [Whitepaper (CN)](./docs/WHITEPAPER.md)
- [Deployment Guide](./docs/DEPLOYMENT_GUIDE.md)
- [UI Style Guide](./docs/UI_STYLE_GUIDE.md)
- [VDID Integration](./docs/VDID_INTEGRATION.md)
- [Quick Start](./docs/guides/QUICK_START.md)

## Design System

## πŸ” Authentication
| Token | Value | Usage |
|-------|-------|-------|
| Brand Color | `#7C85ED` | Accent, links, interactive elements |
| Typography | Space Grotesk / Inter | Headings / Body text |
| Background | `#FAFAFA` / `#0F0F12` | Light / Dark mode |
| Radius | `8px` / `12px` / `16px` | Buttons / Cards / Modals |
| Philosophy | Restrained & authoritative | No gradients, no marketing fluff |

VSPEC uses **VDID** (Decentralized Identity) for secure, privacy-first authentication. Users can sign in without traditional username/password systems.
## Pricing

## 🌐 Responsive Design
| | Personal | PRO | Team |
|---|---------|-----|------|
| **Price** | Free | $12/mo | $8/person/mo |
| **Documents** | 5 cloud | Unlimited | Unlimited |
| **AI Analyses** | 20/day | Unlimited | Unlimited |
| **One-click Fix** | - | Included | Included |
| **Batch Processing** | - | Included | Included |
| **Publishing** | - | Custom domain | Custom domain |
| **Collaboration** | - | 3 people | Unlimited |
| **Export** | Markdown | PDF/DOCX/HTML | PDF/DOCX/HTML |

All components are fully responsive with automatic breakpoints for mobile, tablet, and desktop views.
## License

## πŸ“„ License
Proprietary - All rights reserved.

Proprietary - All rights reserved
---

## 🀝 Contributing
<div align="center">

This is a private project. For contribution guidelines, please contact the maintainers.
**VSPEC** - The Documentation Scope for AI Era

---
[Website](https://vspec.pub) &nbsp;&middot;&nbsp; [Docs](https://vspec.pub/docs) &nbsp;&middot;&nbsp; [Pricing](https://vspec.pub/pricing)

**VSPEC** - Elevating documentation with AI-driven intelligence and restrained design.
</div>
Loading