jekyll-theme-zer0 0.10.3 β†’ 0.10.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  title: zer0-mistakes
3
3
  sub-title: Jekyll Theme
4
4
  description: Docker-optimized Jekyll theme with AI-powered installation automation and comprehensive error handling.
5
- version: 0.9.2
5
+ version: 0.10.3
6
6
  layout: landing
7
7
  tags:
8
8
  - jekyll
@@ -14,7 +14,7 @@ categories:
14
14
  - docker
15
15
  - bootstrap
16
16
  created: 2024-02-10T23:51:11.480Z
17
- lastmod: 2025-11-27T00:00:00.000Z
17
+ lastmod: 2025-11-29T00:00:00.000Z
18
18
  draft: false
19
19
  permalink: /
20
20
  slug: zer0
@@ -23,880 +23,655 @@ keywords:
23
23
  - docker
24
24
  - remote-theme
25
25
  - github-pages
26
- date: 2025-09-21T12:00:00.000Z
26
+ date: 2025-11-29T12:00:00.000Z
27
27
  snippet: Docker-first Jekyll theme with remote theme support
28
28
  comments: true
29
+ mermaid: true
29
30
  preview: /assets/images/wizard-on-journey.png
30
31
  hero_image: /assets/images/wizard-on-journey.png
31
32
  excerpt: "Professional Jekyll theme with automated installation, comprehensive error handling, and zero-configuration Docker development"
32
33
  ---
33
34
 
35
+ <div align="center">
36
+
34
37
  [![pages-build-deployment](https://github.com/bamr87/zer0-mistakes/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/bamr87/zer0-mistakes/actions/workflows/pages/pages-build-deployment)
35
38
  [![Gem Version](https://badge.fury.io/rb/jekyll-theme-zer0.svg)](https://badge.fury.io/rb/jekyll-theme-zer0)
36
39
  [![CI](https://github.com/bamr87/zer0-mistakes/actions/workflows/ci.yml/badge.svg)](https://github.com/bamr87/zer0-mistakes/actions/workflows/ci.yml)
37
- [![Auto Version Bump](https://github.com/bamr87/zer0-mistakes/actions/workflows/auto-version-bump.yml/badge.svg)](https://github.com/bamr87/zer0-mistakes/actions/workflows/auto-version-bump.yml)
40
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
38
41
  [![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](https://github.com/bamr87/zer0-mistakes/blob/main/docker-compose.yml)
42
+ [![Bootstrap](https://img.shields.io/badge/Bootstrap-5.3.3-purple.svg)](https://getbootstrap.com/)
39
43
 
40
- # πŸš€ zer0-mistakes Jekyll Theme
41
-
42
- **Professional Jekyll theme** with AI-powered installation, Docker-first development, automated release management, and **VS Code Copilot optimization**. Built for developers who value reliability, modern workflows, AI-assisted development, and zero-configuration setup.
43
-
44
- > **🎯 95% installation success rate** β€’ **⚑ 2-5 minute setup** β€’ **🐳 Universal Docker compatibility** β€’ **πŸ€– AI-powered error recovery** β€’ **πŸš€ Automated releases with semantic versioning** β€’ **πŸ’‘ VS Code Copilot optimized**
45
-
46
- ---
47
-
48
- ## Welcome to Error-Free Jekyll Development
44
+ # πŸš€ zer0-mistakes
49
45
 
50
- **zer0-mistakes** eliminates the complexity and frustration of Jekyll theme setup with intelligent automation, Docker-first development, and comprehensive error handling. Get a professional Jekyll site running in minutes, not hours.
46
+ ### The Self-Healing Jekyll Theme
51
47
 
52
- ### 🎯 Perfect For
48
+ **Docker-first β€’ AI-powered β€’ Privacy-compliant β€’ Zero-configuration**
53
49
 
54
- - **Developers** who value reliable, reproducible development environments
55
- - **Teams** needing consistent setup across different machines and platforms
56
- - **Content creators** who want to focus on writing, not configuration
57
- - **DevOps engineers** seeking containerized, scalable Jekyll deployments
58
- - **Anyone** who's struggled with Jekyll theme installation and dependency issues
50
+ [Quick Start](#-quick-start) β€’ [Features](#-key-features) β€’ [Documentation](#-documentation) β€’ [Contributing](CONTRIBUTING.md)
59
51
 
60
- ### πŸ“Š Proven Results
61
-
62
- | Metric | Traditional Jekyll | zer0-mistakes | Improvement |
63
- | -------------------------- | ---------------------- | --------------- | ----------- |
64
- | **Setup Success Rate** | ~60% | ~95% | **+58%** |
65
- | **Average Setup Time** | 15-30 min | 2-5 min | **-80%** |
66
- | **Cross-Platform Support** | Limited | Universal | **+100%** |
67
- | **Error Recovery** | Manual troubleshooting | Automatic fixes | **+100%** |
68
- | **Docker Compatibility** | Manual setup | Built-in | **+100%** |
69
- | **Documentation Quality** | Basic | Comprehensive | **+200%** |
52
+ </div>
70
53
 
71
54
  ---
72
55
 
73
- ## πŸš€ Quick Start
74
-
75
- ### πŸ“‹ System Requirements
76
-
77
- **Required:**
78
-
79
- - **Docker Desktop** - Universal cross-platform development environment
80
- - **Git** - Version control
81
- - **Bash 4.0+** - For release automation (macOS: `brew install bash`)
82
-
83
- **Optional:**
84
-
85
- - **GitHub CLI** - Enhanced GitHub integration
86
- - **Ruby 3.0+** - For local (non-Docker) development
87
-
88
- ### ⚑ One-Line Installation (Recommended)
89
-
90
- **Get started in under 5 minutes with AI-powered setup:**
56
+ ## πŸ“– Table of Contents
57
+
58
+ - [Overview](#overview)
59
+ - [Quick Start](#-quick-start)
60
+ - [Architecture](#-architecture)
61
+ - [Key Features](#-key-features)
62
+ - [Installation Methods](#-installation-methods)
63
+ - [Project Structure](#-project-structure)
64
+ - [Development Workflow](#-development-workflow)
65
+ - [Deployment](#-deployment)
66
+ - [Documentation](#-documentation)
67
+ - [Release System](#-release-system)
68
+ - [Roadmap](#-roadmap)
69
+ - [Contributing](#-contributing)
70
+ - [Support](#-support)
91
71
 
92
- ```bash
93
- # Create new site with intelligent installation
94
- mkdir my-awesome-site && cd my-awesome-site
95
- curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash
96
-
97
- # Start development immediately
98
- docker-compose up
99
- # Visit: http://localhost:4000
100
- ```
101
-
102
- **What this does automatically:**
103
-
104
- - βœ… Detects your platform (Apple Silicon, Intel, Linux)
105
- - βœ… Downloads and configures all theme files
106
- - βœ… Sets up Docker development environment
107
- - βœ… Creates optimized configurations
108
- - βœ… Handles errors and provides solutions
72
+ ---
109
73
 
110
- ### πŸ”§ Manual Installation Options
74
+ ## Overview
111
75
 
112
- <details>
113
- <summary>Click to expand manual installation methods</summary>
76
+ **zer0-mistakes** is a professional Jekyll theme engineered to eliminate setup friction and provide a seamless development experience. With AI-powered error recovery, Docker containerization, and comprehensive automation, you can go from zero to deployed in under 5 minutes.
114
77
 
115
- #### Method 1: GitHub Remote Theme
78
+ ```mermaid
79
+ graph LR
80
+ subgraph "🎯 Your Goal"
81
+ A[Beautiful Website]
82
+ end
83
+
84
+ subgraph "⚑ zer0-mistakes"
85
+ B[One Command] --> C[Auto-Configure]
86
+ C --> D[Docker Ready]
87
+ D --> E[Live Preview]
88
+ end
89
+
90
+ subgraph "πŸš€ Result"
91
+ F[Production Site]
92
+ end
93
+
94
+ A --> B
95
+ E --> F
96
+
97
+ style A fill:#e1f5fe
98
+ style F fill:#c8e6c9
99
+ ```
100
+
101
+ ### Why zer0-mistakes?
102
+
103
+ | Challenge | Traditional Jekyll | zer0-mistakes |
104
+ |-----------|-------------------|---------------|
105
+ | **Setup Time** | 15-30 minutes | **2-5 minutes** |
106
+ | **Success Rate** | ~60% | **~95%** |
107
+ | **Platform Support** | Limited | **Universal** |
108
+ | **Error Handling** | Manual debugging | **Self-healing** |
109
+ | **Dependencies** | Ruby + Bundler + Jekyll | **Docker only** |
116
110
 
117
- Perfect for GitHub Pages hosting:
111
+ ---
118
112
 
119
- ```bash
120
- # Add to your _config.yml
121
- remote_theme: "bamr87/zer0-mistakes"
113
+ ## πŸš€ Quick Start
122
114
 
123
- # Add to your Gemfile
124
- gem "jekyll-remote-theme"
125
- ```
115
+ ### Prerequisites
126
116
 
127
- #### Method 2: Fork & Customize
117
+ - **Docker Desktop** ([download](https://www.docker.com/products/docker-desktop))
118
+ - **Git** ([download](https://git-scm.com/))
128
119
 
129
- For extensive theme development:
120
+ ### One-Line Installation
130
121
 
131
122
  ```bash
132
- # Fork on GitHub, then clone
133
- gh repo fork bamr87/zer0-mistakes --clone
134
- cd zer0-mistakes
135
-
136
- # Start development
137
- docker-compose up
123
+ mkdir my-site && cd my-site && curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash
138
124
  ```
139
125
 
140
- #### Method 3: Local Installation
141
-
142
- Install from local repository:
126
+ ### Start Development
143
127
 
144
128
  ```bash
145
- # Clone the repository
146
- git clone https://github.com/bamr87/zer0-mistakes.git
147
- cd zer0-mistakes
148
-
149
- # Install to new directory
150
- ./install.sh ../my-new-site
151
- cd ../my-new-site
152
129
  docker-compose up
130
+ # 🌐 Open http://localhost:4000
153
131
  ```
154
132
 
155
- </details>
156
-
157
- ## ✨ What Makes This Special
158
-
159
- ### πŸ€– **AI-Powered Intelligence & VS Code Copilot Integration**
160
-
161
- - **Smart Error Detection** - 1,090-line install.sh with 27+ error recovery scenarios
162
- - **Platform Optimization** - Automatic detection of Apple Silicon, Intel, and Linux
163
- - **Self-Healing Setup** - 95% installation success rate with intelligent fallback strategies
164
- - **Intelligent Diagnostics** - Actionable solutions for Docker, Ruby, and Jekyll issues
165
- - **VS Code Copilot Optimized** - 805-line copilot-instructions.md with file-specific guidelines
166
- - **AI Development Workflows** - Complete seed documentation system for AI-assisted development
167
- - **Comprehensive Context** - 17,500+ lines of seed documentation in `.github/seed/`
168
-
169
- ### 🐳 **Docker-First Development**
170
-
171
- - **Universal Compatibility** - Works identically on all platforms
172
- - **Zero Local Dependencies** - No Ruby/Jekyll installation required
173
- - **Instant Setup** - `docker-compose up` and you're running
174
- - **Isolated Environment** - No conflicts with other projects
175
-
176
- ### 🎨 **Modern Design System**
177
-
178
- - **Bootstrap 5.3** - Latest responsive framework with dark mode
179
- - **Professional Layouts** - Blog, landing, documentation, and collection templates
180
- - **SEO Optimized** - Built-in meta tags, structured data, and social sharing
181
- - **Performance Focused** - Optimized loading, caching, and Core Web Vitals
182
-
183
- ### πŸ“Š **Privacy-First Analytics & Tracking**
184
-
185
- - **PostHog Integration** - Privacy-first analytics with GDPR/CCPA compliance out-of-the-box
186
- - **Cookie Consent Management** - 382-line consent system with granular permissions and 365-day persistence
187
- - **Custom Event Tracking** - Automatic tracking of downloads, external links, scroll depth, and Jekyll-specific events
188
- - **Development Safety** - Analytics completely disabled in development environment (no data leakage)
189
- - **User Privacy Controls** - Respect Do Not Track, full opt-out mechanisms, input masking, IP anonymization
190
- - **Comprehensive Insights** - Page views, user journeys, content engagement, session recordings (optional), and performance metrics
191
- - **Secure Cookies** - Production-ready with secure cookie flags and localStorage+cookie persistence
192
-
193
- ### 🌐 **Deployment Ready**
194
-
195
- - **GitHub Pages** - Zero-config deployment with remote theme
196
- - **Azure Static Web Apps** - Pre-configured CI/CD workflows
197
- - **Custom Domains** - SSL/TLS and CDN ready
198
- - **Multiple Hosting** - Works with Netlify, Vercel, and custom servers
199
-
200
- ### πŸ€– **Automated Release Management**
201
-
202
- - **Smart Version Bumping** - Analyzes commits and automatically increments versions
203
- - **Conventional Commits** - Follows semantic versioning based on commit patterns
204
- - **Automated Changelogs** - Generates release notes from commit history
205
- - **RubyGems Publishing** - Automatically publishes gem releases
206
- - **GitHub Releases** - Creates comprehensive release pages with assets
207
- - **CI/CD Integration** - Seamless automation with GitHub Actions
208
-
209
- ### ℹ️ **Automatic Theme Version Display**
210
-
211
- - **Zero Configuration** - Theme version displays automatically, no hardcoding needed
212
- - **System Information** - Shows Jekyll, Ruby, and build environment details
213
- - **Always Accessible** - Info modal available from header (βš™οΈ) and footer on every page
214
- - **Dynamic Extraction** - Version pulled from gem specification during build
215
- - **Comprehensive Details** - Lists active plugins, technology stack, and helpful links
216
- - **GitHub Pages Compatible** - Works with both local gems and remote themes
217
-
218
- [Learn more about the Theme Version Feature β†’](docs/THEME_VERSION_FEATURE.md)
219
-
220
- > πŸ“– **Learn more**: [Automated Version System Documentation](AUTOMATED_VERSION_SYSTEM.md)
221
-
222
- ### πŸ“Š **Mermaid Diagram Integration** _(New in v0.3.0)_
223
-
224
- - **Complete Diagram Support** - Flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, Gantt charts, pie charts, git graphs, journey diagrams, and mindmaps
225
- - **GitHub Pages Compatible** - Works seamlessly with both local development and GitHub Pages deployment
226
- - **Conditional Loading** - Only loads Mermaid when needed, optimizing performance
227
- - **Responsive Design** - Diagrams automatically scale across all devices
228
- - **Dark Mode Support** - Forest theme optimized for dark mode compatibility
229
- - **Comprehensive Documentation** - Complete user guide with live examples and troubleshooting
230
- - **Automated Testing** - 16 automated tests covering all aspects of functionality
231
-
232
- > πŸ“– **Learn more**: [Mermaid Documentation](/docs/jekyll/mermaid/) β€’ [Integration Tutorial](/docs/jekyll/jekyll-diagram-with-mermaid/) β€’ [Test Suite](/docs/jekyll/mermaid-test-suite/)
233
-
234
- ### 🌱 **Comprehensive Seed Documentation System** _(New in v0.6.0)_
235
-
236
- - **Complete Rebuild Blueprint** - 17,500+ lines of documentation for full project reconstruction
237
- - **AI Agent Optimized** - Structured for autonomous project building with 95%+ success rate
238
- - **Modular Architecture** - 5 specialized seed files (prompt, implementation, build, components, README)
239
- - **Full Source Code** - Every automation script documented with complete implementations
240
- - **Step-by-Step Build** - 10-phase reconstruction guide from empty directory to deployment
241
- - **GitHub Copilot Ready** - Comprehensive instructions for AI-assisted development
242
-
243
- > πŸ“– **Explore**: [Seed Documentation System](.github/seed/README.md) β€’ [Project Blueprint](.seed.md) β€’ [Build Guide](.github/seed/seed.build.md)
244
-
245
- ## πŸ“š Documentation Architecture
246
-
247
- Zer0-Mistakes features a **dual documentation structure** designed for different audiences and use cases:
248
-
249
- ### πŸ› οΈ **Technical Documentation** β†’ [`/docs/`](docs/)
250
-
251
- **Repository-specific technical documentation** (MDX format) for developers and contributors:
252
-
253
- | Directory | Purpose | Target Audience |
254
- | --------------------------------------------- | ---------------------------------------------------- | ------------------------ |
255
- | [`/docs/systems/`](docs/systems/) | Infrastructure automation, CI/CD, build processes | DevOps & Contributors |
256
- | [`/docs/features/`](docs/features/) | Theme feature implementation, component architecture | Developers & Maintainers |
257
- | [`/docs/configuration/`](docs/configuration/) | Development setup, Docker, environment configuration | Contributors |
258
- | [`/docs/releases/`](docs/releases/) | Version history, migration guides, technical changes | All Technical Users |
259
- | [`/docs/jekyll/`](docs/jekyll/) | Jekyll optimization, plugins, advanced configuration | Jekyll Developers |
260
-
261
- **Key characteristics:**
262
-
263
- - **MDX format** with interactive components and rich code examples
264
- - **Source code focused** with direct references to `_layouts/`, `_includes/`, `scripts/`
265
- - **Architecture documentation** explaining how features are built and maintained
266
- - **Developer workflows** including testing, deployment, and contribution guidelines
267
-
268
- ### πŸ“– **Public Documentation** β†’ [`/pages/_docs/`](pages/_docs/)
269
-
270
- **Published online documentation** (Markdown format) for end-users and general developers:
271
-
272
- | Content Type | Purpose | Source |
273
- | ----------------------- | --------------------------------------------------- | ----------------------------------- |
274
- | **Technology Guides** | General Jekyll, Bootstrap, Ruby documentation | Imported & curated external docs |
275
- | **User Tutorials** | How to use and customize the theme | Original content for users |
276
- | **Reference Materials** | API docs, configuration options, troubleshooting | Converted from technical docs |
277
- | **External Imports** | Official documentation from Jekyll, Bootstrap, etc. | Git submodules & processing scripts |
278
-
279
- **Key characteristics:**
280
-
281
- - **Markdown format** optimized for Jekyll rendering and online consumption
282
- - **User-focused** content targeting theme adopters and general developers
283
- - **Processed content** converted from MDX sources and external documentation
284
- - **Published online** at [zer0-mistakes.org/docs](https://bamr87.github.io/zer0-mistakes/docs/)
285
-
286
- ### πŸ”„ **Content Flow & Conversion**
287
-
288
133
  ```mermaid
289
- graph LR
290
- A[Technical Docs<br/>/docs/ *.mdx] --> B[Processing Scripts]
291
- B --> C[Public Docs<br/>/pages/_docs/ *.md]
292
- D[External Docs<br/>Jekyll, Bootstrap] --> E[Import Scripts]
293
- E --> C
294
- C --> F[Jekyll Build]
295
- F --> G[Published Site]
134
+ sequenceDiagram
135
+ participant You
136
+ participant Install Script
137
+ participant Docker
138
+ participant Browser
139
+
140
+ You->>Install Script: curl ... | bash
141
+ Install Script->>Install Script: Detect platform
142
+ Install Script->>Install Script: Download theme files
143
+ Install Script->>Install Script: Configure Docker
144
+ Install Script-->>You: βœ… Ready!
145
+
146
+ You->>Docker: docker-compose up
147
+ Docker->>Docker: Build Jekyll container
148
+ Docker->>Docker: Install dependencies
149
+ Docker-->>Browser: Serve on :4000
150
+
151
+ Browser-->>You: πŸŽ‰ Live site!
296
152
  ```
297
153
 
298
- **Documentation Workflow:**
299
-
300
- 1. **Technical implementation** documented in `/docs/` using MDX for rich content
301
- 2. **Processing pipeline** converts and sanitizes content for public consumption
302
- 3. **External documentation** imported from official sources and integrated
303
- 4. **Jekyll rendering** builds and serves final documentation site
304
-
305
- > **πŸ“ Quick Navigation**: [Technical Docs](docs/) β€’ [Public Documentation](pages/_docs/) β€’ [GitHub Copilot Instructions](.github/instructions/) β€’ [Contributing Guidelines](CONTRIBUTING.md)
306
-
307
- ## πŸ“‹ Prerequisites
308
-
309
- Before you begin, ensure you have:
310
-
311
- - **Docker Desktop** - [Download here](https://www.docker.com/products/docker-desktop) (recommended)
312
- - **Git** - For version control and repository management
313
- - **Text Editor** - VS Code, Sublime Text, or your preferred editor
314
-
315
- **Optional but helpful:**
316
-
317
- - **GitHub CLI** - For easier repository management
318
- - **Ruby 3.0+** - If you prefer local development over Docker
319
-
320
- ## 🎯 Remote Theme Setup
321
-
322
- ### Step 1: Create Your Site Repository
323
-
324
- ```bash
325
- # Create new repository
326
- mkdir my-awesome-site
327
- cd my-awesome-site
328
- git init
329
- ```
330
-
331
- ### Step 2: Add Remote Theme Configuration
332
-
333
- Create `_config.yml`:
154
+ ---
334
155
 
335
- ```yaml
336
- # Remote theme configuration
337
- remote_theme: "bamr87/zer0-mistakes"
156
+ ## πŸ— Architecture
338
157
 
339
- # Site settings
340
- title: Your Site Title
341
- email: your-email@example.com
342
- description: >-
343
- Your site description here. This will appear in search engines
344
- and social media previews.
158
+ ### System Overview
345
159
 
346
- # GitHub Pages configuration
347
- plugins:
348
- - jekyll-remote-theme
349
- - jekyll-feed
350
- - jekyll-sitemap
351
- - jekyll-seo-tag
352
- - jekyll-paginate
353
-
354
- # Build settings
355
- markdown: kramdown
356
- highlighter: rouge
357
- permalink: /:categories/:year/:month/:day/:title/
358
- paginate: 10
359
- paginate_path: "/blog/page:num/"
360
- ```
160
+ ```mermaid
161
+ flowchart TB
162
+ subgraph Input["πŸ“ Content Layer"]
163
+ MD[Markdown Files]
164
+ DATA[YAML Data]
165
+ ASSETS[Static Assets]
166
+ end
167
+
168
+ subgraph Theme["🎨 Theme Layer"]
169
+ LAYOUTS[_layouts/]
170
+ INCLUDES[_includes/]
171
+ SASS[_sass/]
172
+ end
173
+
174
+ subgraph Build["βš™οΈ Build Layer"]
175
+ JEKYLL[Jekyll Engine]
176
+ PLUGINS[Plugins]
177
+ LIQUID[Liquid Templates]
178
+ end
179
+
180
+ subgraph Output["🌐 Output Layer"]
181
+ HTML[Static HTML]
182
+ CSS[Compiled CSS]
183
+ JS[JavaScript]
184
+ end
185
+
186
+ subgraph Deploy["πŸš€ Deploy Layer"]
187
+ GHPAGES[GitHub Pages]
188
+ DOCKER[Docker Container]
189
+ CDN[CDN/Custom Host]
190
+ end
191
+
192
+ MD --> JEKYLL
193
+ DATA --> JEKYLL
194
+ ASSETS --> JEKYLL
195
+
196
+ LAYOUTS --> JEKYLL
197
+ INCLUDES --> JEKYLL
198
+ SASS --> JEKYLL
199
+
200
+ JEKYLL --> HTML
201
+ JEKYLL --> CSS
202
+ JEKYLL --> JS
203
+
204
+ HTML --> GHPAGES
205
+ HTML --> DOCKER
206
+ HTML --> CDN
207
+ ```
208
+
209
+ ### Technology Stack
361
210
 
362
- ### Step 3: Add Development Configuration
211
+ ```mermaid
212
+ pie title Technology Distribution
213
+ "Jekyll (Static Gen)" : 30
214
+ "Bootstrap 5.3 (UI)" : 25
215
+ "Docker (Dev Env)" : 20
216
+ "Liquid (Templates)" : 15
217
+ "PostHog (Analytics)" : 10
218
+ ```
219
+
220
+ | Layer | Technology | Purpose |
221
+ |-------|-----------|---------|
222
+ | **Framework** | Jekyll 3.9.5 | Static site generation |
223
+ | **Styling** | Bootstrap 5.3.3 | Responsive UI components |
224
+ | **Development** | Docker | Cross-platform consistency |
225
+ | **Templates** | Liquid | Dynamic content rendering |
226
+ | **Analytics** | PostHog | Privacy-first tracking |
227
+ | **Diagrams** | Mermaid 10+ | Documentation visuals |
363
228
 
364
- Create `_config_dev.yml` for local development:
229
+ ---
365
230
 
366
- ```yaml
367
- # Development overrides
368
- url: "http://localhost:4000"
369
- baseurl: ""
231
+ ## ✨ Key Features
370
232
 
371
- # Development plugins
372
- plugins:
373
- - jekyll-remote-theme
374
- - jekyll-feed
375
- - jekyll-sitemap
376
- - jekyll-seo-tag
377
- - jekyll-paginate
378
- - jekyll-livereload
379
-
380
- # Development settings
381
- incremental: true
382
- livereload: true
383
- open_url: true
384
- ```
233
+ ### πŸ€– AI-Powered Installation
385
234
 
386
- ### Step 4: Create Docker Environment
235
+ The 1,090-line `install.sh` script provides intelligent error recovery with 27+ automated fix scenarios:
387
236
 
388
- Create `docker-compose.yml`:
237
+ ```mermaid
238
+ flowchart TD
239
+ START([Start Installation]) --> DETECT[Detect Platform]
240
+ DETECT --> CHECK{Prerequisites OK?}
241
+
242
+ CHECK -->|Yes| DOWNLOAD[Download Theme]
243
+ CHECK -->|No| FIX[Auto-Fix Issues]
244
+ FIX --> CHECK
245
+
246
+ DOWNLOAD --> CONFIG[Configure Docker]
247
+ CONFIG --> VALIDATE{Build Success?}
248
+
249
+ VALIDATE -->|Yes| DONE([βœ… Ready!])
250
+ VALIDATE -->|No| DIAGNOSE[Diagnose Error]
251
+ DIAGNOSE --> RECOVER[Apply Fix]
252
+ RECOVER --> VALIDATE
253
+
254
+ style START fill:#e3f2fd
255
+ style DONE fill:#c8e6c9
256
+ style FIX fill:#fff3e0
257
+ style RECOVER fill:#fff3e0
258
+ ```
259
+
260
+ ### 🐳 Docker-First Development
261
+
262
+ Zero local dependencies required. Works identically across all platforms:
389
263
 
390
264
  ```yaml
265
+ # docker-compose.yml - That's all you need!
391
266
  services:
392
267
  jekyll:
393
268
  image: jekyll/jekyll:latest
394
269
  platform: linux/amd64
395
- command: jekyll serve --watch --force_polling --config "_config.yml,_config_dev.yml" --host 0.0.0.0 --port 4000
396
- volumes:
397
- - ./:/app
398
- ports:
399
- - "4000:4000"
400
- working_dir: /app
401
- environment:
402
- JEKYLL_ENV: development
270
+ command: jekyll serve --config "_config.yml,_config_dev.yml"
271
+ ports: ["4000:4000"]
272
+ volumes: ["./:/app"]
403
273
  ```
404
274
 
405
- ### Step 5: Add Essential Files
406
-
407
- Create `Gemfile`:
408
-
409
- ```ruby
410
- source "https://rubygems.org"
411
-
412
- gem "github-pages", group: :jekyll_plugins
413
- gem "jekyll-remote-theme"
275
+ ### πŸ”’ Privacy-First Analytics
414
276
 
415
- group :jekyll_plugins do
416
- gem "jekyll-feed"
417
- gem "jekyll-sitemap"
418
- gem "jekyll-seo-tag"
419
- gem "jekyll-paginate"
420
- end
421
- ```
277
+ GDPR/CCPA compliant PostHog integration with granular consent:
422
278
 
423
- Create `index.md`:
279
+ ```mermaid
280
+ stateDiagram-v2
281
+ [*] --> PageLoad
282
+ PageLoad --> ConsentCheck
283
+
284
+ ConsentCheck --> Disabled: DNT Enabled
285
+ ConsentCheck --> ShowBanner: No Consent
286
+ ConsentCheck --> Tracking: Has Consent
287
+
288
+ ShowBanner --> Tracking: Accept
289
+ ShowBanner --> Disabled: Decline
290
+
291
+ Tracking --> DataCollection
292
+ DataCollection --> Anonymize
293
+ Anonymize --> PostHog
294
+
295
+ Disabled --> [*]
296
+ PostHog --> [*]
297
+ ```
298
+
299
+ ### πŸ“Š Mermaid Diagram Support
300
+
301
+ 10+ diagram types with GitHub Pages compatibility:
302
+
303
+ | Type | Syntax | Use Case |
304
+ |------|--------|----------|
305
+ | Flowchart | `graph TD` | Process flows |
306
+ | Sequence | `sequenceDiagram` | Interactions |
307
+ | Class | `classDiagram` | OOP structures |
308
+ | State | `stateDiagram-v2` | State machines |
309
+ | ER | `erDiagram` | Database schemas |
310
+ | Gantt | `gantt` | Timelines |
311
+ | Pie | `pie` | Distributions |
312
+ | Git | `gitGraph` | Branch history |
424
313
 
425
- ```markdown
426
314
  ---
427
- layout: home
428
- title: Home
429
- ---
430
-
431
- # Welcome to Your Site
432
315
 
433
- Your content goes here. This theme provides a solid foundation
434
- for your Jekyll site with Bootstrap 5 styling and Docker development.
435
- ```
316
+ ## πŸ“¦ Installation Methods
436
317
 
437
- ### Step 6: Start Development
318
+ ### Method 1: AI-Powered Install (Recommended)
438
319
 
439
320
  ```bash
440
- # Start the development server
441
- docker-compose up
442
-
443
- # Your site will be available at http://localhost:4000
321
+ curl -fsSL https://raw.githubusercontent.com/bamr87/zer0-mistakes/main/install.sh | bash
444
322
  ```
445
323
 
446
- ## 🚒 Deployment Options
447
-
448
- ### GitHub Pages (Automatic)
449
-
450
- 1. Push your repository to GitHub
451
- 2. Go to repository Settings β†’ Pages
452
- 3. Select source branch (usually `main`)
453
- 4. Your site will be automatically built and deployed
454
-
455
- ### Manual Deployment
456
-
457
- ```bash
458
- # Build production site
459
- docker-compose run --rm jekyll jekyll build --config "_config.yml"
324
+ ### Method 2: Remote Theme (GitHub Pages)
460
325
 
461
- # Deploy the _site directory to your hosting provider
326
+ ```yaml
327
+ # _config.yml
328
+ remote_theme: "bamr87/zer0-mistakes"
329
+ plugins:
330
+ - jekyll-remote-theme
462
331
  ```
463
332
 
464
- ## πŸ“¦ Installation Script Features
465
-
466
- The automated installation script provides:
467
-
468
- - **Smart Detection** - Identifies existing Jekyll sites vs. new setups
469
- - **Dependency Resolution** - Installs required gems and configurations
470
- - **Error Recovery** - Fixes common issues automatically
471
- - **Docker Setup** - Creates optimized Docker Compose environment
472
- - **GitHub Pages Prep** - Configures for seamless GitHub Pages deployment
473
-
474
- ## πŸ”§ Prerequisites
475
-
476
- ### Required Software
477
-
478
- - **Docker** - For containerized development
479
- - **Git** - For version control
480
- - **Text Editor** - VS Code recommended
481
-
482
- ### Installation Commands
333
+ ### Method 3: Fork & Customize
483
334
 
484
335
  ```bash
485
- # Install Docker (macOS with Homebrew)
486
- brew install --cask docker
487
-
488
- # Install Git (if not already installed)
489
- brew install git
490
-
491
- # Verify installations
492
- docker --version
493
- git --version
494
- ```
495
-
496
- ## 🎨 Customization
497
-
498
- ### Theme Structure
499
-
500
- ```text
501
- your-site/
502
- β”œβ”€β”€ _config.yml # Main configuration
503
- β”œβ”€β”€ _config_dev.yml # Development overrides
504
- β”œβ”€β”€ docker-compose.yml # Docker environment
505
- β”œβ”€β”€ Gemfile # Ruby dependencies
506
- β”œβ”€β”€ index.md # Homepage
507
- β”œβ”€β”€ _data/ # Site data files
508
- β”œβ”€β”€ _posts/ # Blog posts
509
- β”œβ”€β”€ _pages/ # Additional pages
510
- └── assets/ # Images, CSS, JS
336
+ gh repo fork bamr87/zer0-mistakes --clone
337
+ cd zer0-mistakes
338
+ docker-compose up
511
339
  ```
512
340
 
513
- ### Custom Styling
514
-
515
- Create `assets/css/custom.css`:
341
+ ### Method 4: Ruby Gem
516
342
 
517
- ```css
518
- /* Your custom styles here */
519
- :root {
520
- --primary-color: #your-color;
521
- --secondary-color: #your-secondary;
522
- }
523
-
524
- /* Override theme styles */
525
- .navbar-brand {
526
- color: var(--primary-color) !important;
527
- }
343
+ ```ruby
344
+ # Gemfile
345
+ gem "jekyll-theme-zer0", "~> 0.10"
528
346
  ```
529
347
 
530
- ### Navigation Setup
348
+ ---
531
349
 
532
- Edit `_data/navigation.yml`:
350
+ ## πŸ“ Project Structure
533
351
 
534
- ```yaml
535
- main:
536
- - title: "Home"
537
- url: /
538
- - title: "About"
539
- url: /about/
540
- - title: "Blog"
541
- url: /blog/
542
- - title: "Contact"
543
- url: /contact/
544
- ```
545
-
546
- ## πŸ§ͺ Testing & Validation
352
+ ```mermaid
353
+ graph TD
354
+ ROOT[zer0-mistakes/] --> CONFIG[Configuration]
355
+ ROOT --> THEME[Theme Components]
356
+ ROOT --> CONTENT[Content]
357
+ ROOT --> AUTOMATION[Automation]
358
+
359
+ CONFIG --> CFG1[_config.yml]
360
+ CONFIG --> CFG2[_config_dev.yml]
361
+ CONFIG --> CFG3[docker-compose.yml]
362
+
363
+ THEME --> LAYOUTS[_layouts/]
364
+ THEME --> INCLUDES[_includes/]
365
+ THEME --> SASS[_sass/]
366
+ THEME --> ASSETS[assets/]
367
+
368
+ CONTENT --> PAGES[pages/]
369
+ CONTENT --> DATA[_data/]
370
+ CONTENT --> DOCS[docs/]
371
+
372
+ AUTOMATION --> SCRIPTS[scripts/]
373
+ AUTOMATION --> TESTS[test/]
374
+ AUTOMATION --> WORKFLOWS[.github/workflows/]
375
+
376
+ style ROOT fill:#e8f5e9
377
+ style CONFIG fill:#e3f2fd
378
+ style THEME fill:#fff3e0
379
+ style CONTENT fill:#fce4ec
380
+ style AUTOMATION fill:#f3e5f5
381
+ ```
382
+
383
+ ### Key Directories
384
+
385
+ | Directory | Purpose | Key Files |
386
+ |-----------|---------|-----------|
387
+ | `_layouts/` | Page templates | `default.html`, `journals.html`, `landing.html` |
388
+ | `_includes/` | Reusable components | `core/`, `components/`, `analytics/` |
389
+ | `_sass/` | Stylesheets | `custom.scss`, `core/` |
390
+ | `assets/` | Static files | `css/`, `js/`, `images/` |
391
+ | `scripts/` | Automation | `release`, `build`, `version.sh` |
392
+ | `docs/` | Technical docs | `features/`, `systems/`, `releases/` |
547
393
 
548
- ### Quick Health Check
394
+ ---
549
395
 
550
- After installation, verify everything is working:
396
+ ## πŸ”„ Development Workflow
551
397
 
552
- ```bash
553
- # 1. Check installation files
554
- ls -la _config.yml docker-compose.yml INSTALLATION.md
555
-
556
- # 2. Validate configuration
557
- docker-compose config # Should show no errors
558
- ruby -e "require 'yaml'; YAML.load_file('_config.yml')" # Should load without errors
559
-
560
- # 3. Test Docker environment
561
- docker-compose up -d # Start in background
562
- sleep 30 # Wait for Jekyll to start
563
- curl -I http://localhost:4000 # Should return HTTP 200 OK
564
- docker-compose down # Stop services
398
+ ```mermaid
399
+ gitGraph
400
+ commit id: "Clone/Install"
401
+ branch feature
402
+ checkout feature
403
+ commit id: "Make Changes"
404
+ commit id: "Test Locally"
405
+ checkout main
406
+ merge feature id: "PR Merged"
407
+ commit id: "Auto Version" type: HIGHLIGHT
408
+ commit id: "Gem Published"
409
+ commit id: "GitHub Release"
565
410
  ```
566
411
 
567
- ### πŸ”¬ Comprehensive Test Suite
568
-
569
- Our testing framework validates the entire installation and deployment process:
570
-
571
- #### Quick Validation (30 seconds)
412
+ ### Daily Development
572
413
 
573
414
  ```bash
574
- # Fast validation without Docker
575
- ./test/validate_installation.sh
576
- ```
415
+ # Start development server
416
+ docker-compose up
577
417
 
578
- #### Docker Deployment Test (2-3 minutes)
418
+ # Make changes (auto-reload enabled)
419
+ # Edit files in _layouts/, _includes/, pages/
579
420
 
580
- ```bash
581
- # Test Docker-specific functionality
582
- ./test/test_docker_deployment.sh --verbose
421
+ # Run tests
422
+ ./test/test_runner.sh
583
423
 
584
- # Keep test site for inspection
585
- ./test/test_docker_deployment.sh --no-cleanup
424
+ # Commit changes
425
+ git commit -m "feat: add new component"
586
426
  ```
587
427
 
588
- #### Complete Installation Test (3-5 minutes)
428
+ ### Testing Commands
589
429
 
590
430
  ```bash
591
- # Test all installation methods
592
- ./test/test_installation_complete.sh
593
-
594
- # Skip remote tests for faster execution
595
- ./test/test_installation_complete.sh --skip-remote --verbose
596
- ```
597
-
598
- #### End-to-End Deployment Test (5-10 minutes)
431
+ # Quick validation
432
+ ./test/validate_installation.sh
599
433
 
600
- ```bash
601
- # Full deployment workflow validation
602
- ./test/test_deployment_complete.sh
434
+ # Full test suite
435
+ ./test/test_runner.sh --verbose
603
436
 
604
- # Skip Docker if unavailable
605
- ./test/test_deployment_complete.sh --skip-docker
437
+ # Docker-specific tests
438
+ ./test/test_docker_deployment.sh
606
439
  ```
607
440
 
608
- ### 🎯 Test Results Interpretation
609
-
610
- **βœ… Success Indicators:**
611
-
612
- - HTTP 200 OK response from `http://localhost:4000`
613
- - Jekyll logs show "Server running... press ctrl-c to stop"
614
- - Site content includes zer0-mistakes theme elements
615
- - Live reload header present (`X-Rack-Livereload: 1`)
616
- - Build time under 5 seconds
617
-
618
- **⚠️ Common Issues:**
619
-
620
- - **Port conflicts:** Use `docker-compose run -p 4001:4000 jekyll`
621
- - **Volume mounting:** Use home directory instead of `/tmp`
622
- - **Bundle install slow:** Normal for first run (60-90 seconds)
623
- - **Repository errors:** Check `PAGES_REPO_NWO` environment variable
624
-
625
- **❌ Failure Indicators:**
626
-
627
- - Gemfile contains `gemspec` (should be site-configured)
628
- - Docker container exits immediately
629
- - `_config.yml` syntax errors
630
- - Missing theme files or directories
441
+ ---
631
442
 
632
- ### πŸŽ‰ Validated Test Results
443
+ ## πŸš€ Deployment
633
444
 
634
- **Latest Test Results (September 21, 2025):**
445
+ ### GitHub Pages (Automatic)
635
446
 
447
+ ```mermaid
448
+ sequenceDiagram
449
+ participant Dev as Developer
450
+ participant GH as GitHub
451
+ participant Actions as GitHub Actions
452
+ participant Pages as GitHub Pages
453
+
454
+ Dev->>GH: git push main
455
+ GH->>Actions: Trigger workflow
456
+ Actions->>Actions: jekyll build
457
+ Actions->>Pages: Deploy _site/
458
+ Pages-->>Dev: 🌐 Site live!
636
459
  ```
637
- βœ… Docker Deployment Test: 5/5 tests PASSED (100% success rate)
638
- βœ… Installation Process: All files and directories created correctly
639
- βœ… Gemfile Configuration: Properly configured for Jekyll sites
640
- βœ… Docker Volume Mounting: Working correctly in home directory
641
- βœ… Environment Variables: PAGES_REPO_NWO properly configured
642
- βœ… Jekyll Build & Serve: Site accessible at http://localhost:4000
643
- βœ… Performance: Bundle install ~60s, Jekyll build ~2.3s
644
- ```
645
-
646
- **Test Environment:**
647
460
 
648
- - **OS:** macOS (Apple Silicon)
649
- - **Docker:** Available and functional
650
- - **Ruby:** 2.6.10 (system)
651
- - **Jekyll:** 3.9.5 (via GitHub Pages gem)
652
- - **Build Time:** 2.315 seconds
653
- - **Bundle Install:** 98 gems installed successfully
461
+ 1. Push to `main` branch
462
+ 2. GitHub Actions builds automatically
463
+ 3. Site deploys to GitHub Pages
654
464
 
655
- The theme installation and deployment process has been **thoroughly tested and validated** across multiple scenarios.
656
-
657
- ## πŸ› οΈ Troubleshooting
658
-
659
- ### Quick Fixes
660
-
661
- **🐳 Docker Issues:**
465
+ ### Docker Production
662
466
 
663
467
  ```bash
664
- # Restart Docker Desktop
665
- # Then rebuild containers
666
- docker-compose down && docker-compose up --build
468
+ docker-compose -f docker-compose.prod.yml up -d
667
469
  ```
668
470
 
669
- **⚑ Port Conflicts:**
471
+ ### Custom Hosting
670
472
 
671
473
  ```bash
672
- # Use different port
673
- docker-compose run -p 4001:4000 jekyll
674
- ```
474
+ # Build static site
475
+ docker-compose run --rm jekyll jekyll build
675
476
 
676
- **🍎 Apple Silicon Issues:**
677
-
678
- ```bash
679
- # Force platform if needed
680
- docker-compose up --build
681
- # The linux/amd64 platform is already configured
477
+ # Deploy _site/ to any static host
682
478
  ```
683
479
 
684
- ### Common Issues
480
+ ---
685
481
 
686
- #### Docker Container Won't Start
482
+ ## πŸ“š Documentation
687
483
 
688
- ```bash
689
- # Check Docker is running
690
- docker ps
484
+ ### Documentation Architecture
691
485
 
692
- # Rebuild container
693
- docker-compose down
694
- docker-compose up --build
695
- ```
486
+ ```mermaid
487
+ graph LR
488
+ subgraph Technical["πŸ“‹ /docs/"]
489
+ SYS[systems/]
490
+ FEAT[features/]
491
+ REL[releases/]
492
+ end
493
+
494
+ subgraph Public["πŸ“– /pages/_docs/"]
495
+ GUIDES[User Guides]
496
+ TUTORIALS[Tutorials]
497
+ REF[Reference]
498
+ end
499
+
500
+ subgraph AI["πŸ€– .github/"]
501
+ COPILOT[copilot-instructions.md]
502
+ SEED[seed/]
503
+ INSTR[instructions/]
504
+ end
505
+
506
+ Technical -->|Process| Public
507
+ AI -->|Guides| Technical
508
+
509
+ style Technical fill:#e3f2fd
510
+ style Public fill:#e8f5e9
511
+ style AI fill:#fff3e0
512
+ ```
513
+
514
+ ### Quick Links
515
+
516
+ | Resource | Description |
517
+ |----------|-------------|
518
+ | [πŸ“‹ Technical Docs](docs/) | Architecture, systems, implementation |
519
+ | [πŸ“– User Guides](pages/_docs/) | Published tutorials and references |
520
+ | [πŸ€– Copilot Instructions](.github/copilot-instructions.md) | AI development guidelines |
521
+ | [🌱 Seed Documentation](.github/seed/) | Full reconstruction blueprints |
522
+ | [πŸ“ PRD](PRD.md) | Product requirements & roadmap |
696
523
 
697
- #### Theme Not Loading
524
+ ---
698
525
 
699
- ```bash
700
- # Verify remote_theme setting in _config.yml
701
- remote_theme: "bamr87/zer0-mistakes"
526
+ ## πŸ”§ Release System
702
527
 
703
- # Check Gemfile includes jekyll-remote-theme
704
- gem "jekyll-remote-theme"
705
- ```
528
+ ### Automated Release Pipeline
706
529
 
707
- #### Port Already in Use
530
+ ```mermaid
531
+ flowchart LR
532
+ subgraph Trigger["🎯 Trigger"]
533
+ COMMIT[Commit to main]
534
+ end
535
+
536
+ subgraph Analyze["πŸ” Analyze"]
537
+ PARSE[Parse Commits]
538
+ BUMP[Determine Version]
539
+ end
540
+
541
+ subgraph Build["βš™οΈ Build"]
542
+ CHANGE[Update CHANGELOG]
543
+ VERSION[Bump Version]
544
+ TEST[Run Tests]
545
+ GEM[Build Gem]
546
+ end
547
+
548
+ subgraph Publish["πŸš€ Publish"]
549
+ RUBYGEMS[Push to RubyGems]
550
+ GHREL[GitHub Release]
551
+ TAG[Git Tag]
552
+ end
553
+
554
+ COMMIT --> PARSE --> BUMP
555
+ BUMP --> CHANGE --> VERSION --> TEST --> GEM
556
+ GEM --> RUBYGEMS --> GHREL --> TAG
557
+ ```
558
+
559
+ ### Release Commands
708
560
 
709
561
  ```bash
710
- # Find process using port 4000
711
- lsof -i :4000
562
+ # Preview release
563
+ /opt/homebrew/bin/bash scripts/release patch --dry-run
712
564
 
713
- # Or use different port
714
- docker-compose run -p 4001:4000 jekyll
565
+ # Full release
566
+ /opt/homebrew/bin/bash scripts/release patch # 0.10.3 β†’ 0.10.4
567
+ /opt/homebrew/bin/bash scripts/release minor # 0.10.3 β†’ 0.11.0
568
+ /opt/homebrew/bin/bash scripts/release major # 0.10.3 β†’ 1.0.0
715
569
  ```
716
570
 
717
- #### GitHub Pages Build Fails
571
+ ---
718
572
 
719
- - Ensure `jekyll-remote-theme` plugin is in `_config.yml`
720
- - Check that all plugins are GitHub Pages compatible
721
- - Verify `_config.yml` syntax is valid YAML
573
+ ## πŸ—Ί Roadmap
722
574
 
723
- ### Development Tips
575
+ ```mermaid
576
+ gantt
577
+ title zer0-mistakes Roadmap
578
+ dateFormat YYYY-MM
579
+ section Current
580
+ v0.10.x Maintenance :done, 2025-11, 2025-12
581
+ section Future
582
+ v0.11 - CMS Integration :2026-01, 2026-03
583
+ v0.12 - Advanced Analytics:2026-04, 2026-06
584
+ v0.13 - i18n Support :2026-07, 2026-09
585
+ v1.0 - Production Ready :milestone, 2027-01, 1d
586
+ ```
587
+
588
+ | Version | Target | Features |
589
+ |---------|--------|----------|
590
+ | **v0.11** | Q1 2026 | Headless CMS integration, content API |
591
+ | **v0.12** | Q2 2026 | A/B testing, conversion funnels |
592
+ | **v0.13** | Q3 2026 | Multi-language support (i18n) |
593
+ | **v1.0** | Q1 2027 | Stable API, 90%+ test coverage |
724
594
 
725
- ```bash
726
- # View container logs
727
- docker-compose logs -f jekyll
595
+ ---
728
596
 
729
- # Clean Jekyll cache
730
- docker-compose run --rm jekyll jekyll clean
597
+ ## 🀝 Contributing
731
598
 
732
- # Bundle install in container
733
- docker-compose run --rm jekyll bundle install
599
+ We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
734
600
 
735
- # Access container shell
736
- docker-compose exec jekyll bash
601
+ ```mermaid
602
+ flowchart LR
603
+ FORK[Fork Repo] --> BRANCH[Create Branch]
604
+ BRANCH --> CODE[Make Changes]
605
+ CODE --> TEST[Run Tests]
606
+ TEST --> PR[Open PR]
607
+ PR --> REVIEW[Code Review]
608
+ REVIEW --> MERGE[Merge! πŸŽ‰]
609
+
610
+ style MERGE fill:#c8e6c9
737
611
  ```
738
612
 
739
- ## 🀝 Contributing
740
-
741
- We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
742
-
743
- ### Development Setup
613
+ ### Quick Contribution
744
614
 
745
615
  ```bash
746
- # Fork and clone the repository
747
- git clone https://github.com/YOUR-USERNAME/zer0-mistakes.git
616
+ # Fork and clone
617
+ gh repo fork bamr87/zer0-mistakes --clone
748
618
  cd zer0-mistakes
749
619
 
750
620
  # Create feature branch
751
- git checkout -b feature/amazing-feature
621
+ git checkout -b feature/awesome-feature
752
622
 
753
623
  # Make changes and test
754
624
  docker-compose up
755
-
756
- # Run tests
757
625
  ./test/test_runner.sh
758
626
 
759
- # Build gem (if needed)
760
- ./scripts/build
761
-
762
- # Commit and push
763
- git commit -m "feat: add amazing feature"
764
- git push origin feature/amazing-feature
765
- ```
766
-
767
- ### Release Management
768
-
769
- Our modernized release system uses modular automation:
770
-
771
- ```bash
772
- # Preview release (requires Bash 4.0+)
773
- /opt/homebrew/bin/bash scripts/release patch --dry-run
774
-
775
- # Full release workflow
776
- /opt/homebrew/bin/bash scripts/release patch # or minor, major
777
-
778
- # Quick build & test (no publish)
779
- scripts/release patch --skip-publish --no-github-release
627
+ # Submit PR
628
+ git push origin feature/awesome-feature
780
629
  ```
781
630
 
782
- **System Requirements:**
783
-
784
- - Bash 4.0+ (install on macOS: `brew install bash`)
785
- - Clean git working directory
786
- - RubyGems credentials configured
787
-
788
- For details, see [Release Workflow](CONTRIBUTING.md#-release-process) and [Phase 2 Documentation](docs/PHASE_2_COMPLETE.md).
789
-
790
- ## οΏ½ Documentation
791
-
792
- ### πŸ“– Comprehensive Documentation Center
793
-
794
- All documentation is organized in the [`docs/`](docs/README.md) directory:
795
-
796
- - **[πŸ“‹ Documentation Overview](docs/README.md)** - Complete documentation center with organized structure
797
- - **[πŸš€ Release Documentation](docs/releases/README.md)** - Version history and release notes
798
- - **[⭐ Feature Documentation](docs/features/README.md)** - Detailed feature guides and implementation
799
- - **[βš™οΈ System Documentation](docs/systems/README.md)** - Core systems, automation, and CI/CD
800
- - **[πŸ”§ Configuration Guides](docs/configuration/README.md)** - Setup and hosting configuration
801
- - **[πŸ“ Documentation Templates](docs/templates/README.md)** - Standardized templates for consistent documentation
802
-
803
- ### 🌱 Seed Documentation (AI & Developer Blueprints)
804
-
805
- Comprehensive reconstruction documentation for AI agents and developers:
806
-
807
- - **[Seed Documentation System](.github/seed/README.md)** - Master index and navigation guide (17,500+ lines total)
808
- - **[Project Blueprint](.seed.md)** - Complete technical specifications with evolutionary context
809
- - **[Master Blueprint](.github/seed/seed.prompt.md)** - Full project architecture and specifications (~8,000 lines)
810
- - **[Implementation Code](.github/seed/seed.implementation.md)** - All automation scripts with source code (~3,000 lines)
811
- - **[Build Instructions](.github/seed/seed.build.md)** - 10-phase reconstruction guide (~2,500 lines)
812
- - **[Component Library](.github/seed/seed.components.md)** - Complete theme components (~4,000 lines)
813
-
814
- ### πŸ“Š Recent Releases
815
-
816
- - **[v0.6.0](CHANGELOG.md#060---2025-11-22)** - AI Integration & Privacy Compliance (Current)
817
- - **[v0.5.0](docs/releases/v0.5.0-release-summary.md)** - Comprehensive Sitemap Integration
818
- - **[v0.4.0](docs/releases/v0.4.0-release-summary.md)** - Statistics Dashboard
819
- - **[v0.3.0](docs/releases/v0.3.0-release-notes.md)** - Mermaid Integration v2.0
820
-
821
- ### 🌟 Key Features
822
-
823
- - **[Sitemap Integration](docs/features/sitemap-integration.md)** - Unified site navigation and content discovery
824
- - **[Automated Version System](docs/systems/automated-version-system.md)** - Intelligent release automation
825
- - **[CI/CD Pipeline](docs/systems/cicd-status-report.md)** - Comprehensive testing and deployment
826
- - **[URL Configuration](docs/configuration/url-configuration-guide.md)** - Multi-hosting setup guide
827
- - **[GitHub Copilot Instructions](.github/instructions/README.md)** - AI-assisted development with comprehensive coding guidelines
828
- - **[Product Requirements Document](PRD.md)** - Complete product specification and roadmap
829
-
830
- ## οΏ½πŸ“„ License
831
-
832
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
833
-
834
- ## πŸ“Š Project Statistics
835
-
836
- **Current Version**: 0.6.0
837
- **Installation Success Rate**: 95%
838
- **Setup Time**: 2-5 minutes
839
- **RubyGems Downloads**: 2,500+
840
- **Test Coverage**: 60% (Target: 90% by v0.8.0)
841
- **Documentation**: 17,500+ lines of seed docs + comprehensive guides
842
- **Lighthouse Score**: 95+
843
-
844
- ## πŸ—ΊοΈ Roadmap
845
-
846
- **v0.7.0** (Q2 2026) - Headless CMS Integration
847
-
848
- - Content API (REST/GraphQL)
849
- - Visual front matter editor
850
- - Multi-author collaboration
851
-
852
- **v0.8.0** (Q3 2026) - Advanced Analytics & UX
631
+ ---
853
632
 
854
- - A/B testing framework
855
- - Conversion funnels
856
- - Visual theme customizer
633
+ ## πŸ“ž Support
857
634
 
858
- **v0.9.0** (Q4 2026) - Enhanced Developer Experience
635
+ | Channel | Link |
636
+ |---------|------|
637
+ | πŸ“– Documentation | [zer0-mistakes.org](https://bamr87.github.io/zer0-mistakes/) |
638
+ | πŸ› Issues | [GitHub Issues](https://github.com/bamr87/zer0-mistakes/issues) |
639
+ | πŸ’¬ Discussions | [GitHub Discussions](https://github.com/bamr87/zer0-mistakes/discussions) |
640
+ | πŸ“§ Email | [support@zer0-mistakes.com](mailto:support@zer0-mistakes.com) |
859
641
 
860
- - Multi-language support (i18n)
861
- - Component library browser
862
- - Interactive setup wizard
642
+ ---
863
643
 
864
- **v1.0.0** (Q1 2027) - Production Milestone
644
+ ## πŸ“Š Project Stats
865
645
 
866
- - 90%+ test coverage
867
- - Enterprise support
868
- - Stable API guarantee
646
+ | Metric | Value |
647
+ |--------|-------|
648
+ | **Current Version** | 0.10.3 |
649
+ | **Installation Success** | ~95% |
650
+ | **Setup Time** | 2-5 minutes |
651
+ | **RubyGems Downloads** | 2,500+ |
652
+ | **Documentation** | 17,500+ lines |
653
+ | **Lighthouse Score** | 95+ |
869
654
 
870
- > πŸ“– **Full Roadmap**: [Product Requirements Document](PRD.md)
655
+ ---
871
656
 
872
657
  ## πŸ™ Acknowledgments
873
658
 
874
- - Built with [Jekyll](https://jekyllrb.com/) 3.9.5 static site generator
875
- - Styled with [Bootstrap 5.3.3](https://getbootstrap.com/) framework
876
- - Containerized with [Docker](https://docker.com/) for consistent development
877
- - Analytics by [PostHog](https://posthog.com/) with privacy-first principles
878
- - Diagrams powered by [Mermaid](https://mermaid.js.org/) 10+
879
- - AI-assisted development with [GitHub Copilot](https://github.com/features/copilot)
880
- - Inspired by IT-Journey principles of reliable, self-healing software
659
+ Built with these amazing technologies:
881
660
 
882
- ## πŸ“ž Support
661
+ - [Jekyll](https://jekyllrb.com/) - Static site generation
662
+ - [Bootstrap](https://getbootstrap.com/) - UI framework
663
+ - [Docker](https://docker.com/) - Containerization
664
+ - [PostHog](https://posthog.com/) - Privacy-first analytics
665
+ - [Mermaid](https://mermaid.js.org/) - Diagram rendering
666
+ - [GitHub Copilot](https://github.com/features/copilot) - AI assistance
883
667
 
884
- - **Documentation**: [Theme Documentation](https://bamr87.github.io/zer0-mistakes/)
885
- - **Seed Docs**: [AI Reconstruction Blueprints](.github/seed/README.md)
886
- - **Product Spec**: [Product Requirements Document](PRD.md)
887
- - **Issues**: [GitHub Issues](https://github.com/bamr87/zer0-mistakes/issues)
888
- - **Discussions**: [GitHub Discussions](https://github.com/bamr87/zer0-mistakes/discussions)
889
- - **Email**: [support@zer0-mistakes.com](mailto:support@zer0-mistakes.com)
668
+ ---
890
669
 
891
- ## πŸ† Project Recognition
670
+ <div align="center">
892
671
 
893
- - βœ… **95% Installation Success Rate** - AI-powered error recovery
894
- - βœ… **Zero-Configuration Deployment** - Works immediately on GitHub Pages
895
- - βœ… **Universal Compatibility** - Docker-first for all platforms
896
- - βœ… **Privacy-First Analytics** - GDPR/CCPA compliant out-of-the-box
897
- - βœ… **AI-Ready Architecture** - Comprehensive Copilot integration
898
- - βœ… **Complete Documentation** - 17,500+ lines of reconstruction blueprints
672
+ **Built with ❀️ for the Jekyll community**
899
673
 
900
- ---
674
+ **v0.10.3** β€’ [Changelog](CHANGELOG.md) β€’ [License](LICENSE) β€’ [Contributing](CONTRIBUTING.md)
675
+
676
+ </div>
901
677
 
902
- **Built with ❀️ for the Jekyll community** | **Version 0.6.0** | [Changelog](CHANGELOG.md) | [Contributing](CONTRIBUTING.md) | [License](LICENSE)