jekyll-theme-zer0 0.5.0 → 0.6.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +140 -60
- data/README.md +102 -1
- data/_includes/analytics/posthog.html +281 -0
- data/_includes/components/cookie-consent.html +382 -0
- data/_includes/components/info-section.html +5 -0
- data/_includes/components/theme-info.html +312 -0
- data/_includes/core/footer.html +16 -0
- data/_layouts/root.html +6 -0
- data/assets/css/main.scss +5 -5
- metadata +14 -11
- /data/_sass/{it-journey → core}/_docs.scss +0 -0
- /data/_sass/{it-journey → core}/_syntax.scss +0 -0
- /data/_sass/{it-journey → core}/_theme.scss +0 -0
- /data/_sass/{it-journey → core}/_variables.scss +0 -0
- /data/_sass/{it-journey → core}/code-copy.scss +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 635e2523bd58c7eb746c04e23f0e7a197c2cbaa116520aaa7bdfdc6efac8b704
|
|
4
|
+
data.tar.gz: baefeddf8d0753fc9c41aa43e0ffa2655e496a987078079f380e0358fc46dfdc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 891551b705c5b2384197813bfd3c2d739ff45b9db06fb74f6eab824b42c1876837792c7d8ad2c3a06a557611280d0be1200ff2288b2db57133c8195007dac088
|
|
7
|
+
data.tar.gz: 869251351f5045921230e1019dcaa1cdc36c605eeab92f608085b9ebcbab511896dc1ab87ef421aa1bb1d07c89ea3a9b034331f1008a973f86410e31fe2890ea
|
data/CHANGELOG.md
CHANGED
|
@@ -1,25 +1,94 @@
|
|
|
1
|
-
|
|
1
|
+
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.
|
|
3
|
+
## [0.6.0] - 2025-11-22
|
|
4
4
|
|
|
5
5
|
### Added
|
|
6
|
-
-
|
|
7
|
-
- Add
|
|
8
|
-
-
|
|
6
|
+
- Implement PostHog analytics and cookie consent
|
|
7
|
+
- Add code copy functionality and enhance documentation structure
|
|
8
|
+
- Revise copilot instructions and add comprehensive Jekyll include development guidelines
|
|
9
|
+
- Implement automatic theme version display with comprehensive system information
|
|
10
|
+
- Add automatic theme version display and system information integration
|
|
11
|
+
- Enhance Copilot instructions with comprehensive guidelines
|
|
12
|
+
- Enhance CI/CD testing framework with comprehensive documentation and automated workflows
|
|
9
13
|
|
|
10
14
|
### Changed
|
|
11
|
-
-
|
|
12
|
-
-
|
|
15
|
+
- Ignore .frontmatter directory
|
|
16
|
+
- Update VS Code settings
|
|
17
|
+
- Documentation: Update README with new features and architecture
|
|
18
|
+
- Documentation: Add documentation architecture guidelines
|
|
19
|
+
- Refactor: Clean up redundancies in includes.instructions.md
|
|
20
|
+
- Update version control instructions and add feature documentation
|
|
13
21
|
|
|
14
22
|
### Other
|
|
15
|
-
-
|
|
23
|
+
- Revert "Merge pull request #10 from bamr87/copilot/plan-mdx-file-handling"
|
|
24
|
+
- Add Mermaid documentation and test suite, enhance site structure
|
|
25
|
+
- Merge pull request #9 from bamr87/copilot/setup-copilot-instructions
|
|
26
|
+
- Merge branch 'main' into copilot/setup-copilot-instructions
|
|
27
|
+
- Merge pull request #10 from bamr87/copilot/plan-mdx-file-handling
|
|
28
|
+
- Address code review feedback and add summary documentation
|
|
29
|
+
- Improve MDX processing and add comprehensive tests
|
|
30
|
+
- Add MDX and Tailwind CSS support to zer0-mistakes theme
|
|
31
|
+
- Initial plan
|
|
32
|
+
- Initial plan
|
|
33
|
+
|
|
16
34
|
|
|
17
35
|
|
|
36
|
+
All notable changes to this project will be documented in this file.
|
|
37
|
+
|
|
38
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
39
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
40
|
+
|
|
41
|
+
## [Unreleased]
|
|
42
|
+
|
|
43
|
+
### Added
|
|
44
|
+
- Comprehensive documentation organization system in `/docs/` directory
|
|
45
|
+
- Standardized templates for feature documentation, release notes, and change tracking
|
|
46
|
+
- Organized directory structure for releases, features, systems, and configuration documentation
|
|
47
|
+
|
|
48
|
+
### Changed
|
|
49
|
+
- Migrated scattered documentation files to organized structure
|
|
50
|
+
- Improved documentation discoverability and maintenance
|
|
51
|
+
|
|
52
|
+
## [0.5.0] - 2025-10-25
|
|
53
|
+
|
|
54
|
+
### Added
|
|
55
|
+
- **📊 Comprehensive Sitemap Integration**: Unified layout combining collections, statistics, and navigation
|
|
56
|
+
- Real-time site statistics dashboard with 6 key performance indicators
|
|
57
|
+
- Interactive search and filtering across all content types
|
|
58
|
+
- Collections overview with detailed analysis and recent item previews
|
|
59
|
+
- Advanced content discovery tools with visual organization
|
|
60
|
+
- Mobile-optimized responsive design with touch-friendly interface
|
|
61
|
+
- Dark mode support with theme-aware styling
|
|
62
|
+
- **🔧 Enhanced User Experience Components**: Modern interface with professional design
|
|
63
|
+
- Bootstrap 5-based responsive layout with hover animations
|
|
64
|
+
- WCAG 2.1 AA compliant accessibility features
|
|
65
|
+
- Performance-optimized loading with lazy content rendering
|
|
66
|
+
- Comprehensive documentation and implementation guides
|
|
67
|
+
|
|
68
|
+
### Changed
|
|
69
|
+
- **🏗️ Navigation System**: Consolidated duplicate sitemap entries into unified comprehensive view
|
|
70
|
+
- **🎨 Visual Design**: Updated to modern card-based layout with smooth transitions
|
|
71
|
+
- **📱 Mobile Experience**: Enhanced mobile responsiveness and touch interactions
|
|
72
|
+
|
|
73
|
+
### Fixed
|
|
74
|
+
- **🐛 Dark Mode Compatibility**: Resolved background color issues in dark theme
|
|
75
|
+
- **🔧 Collection Filtering**: Fixed functionality for dynamic content filtering
|
|
76
|
+
- **🔗 Link Navigation**: Corrected internal link behavior and navigation flow
|
|
77
|
+
|
|
78
|
+
### Technical Details
|
|
79
|
+
- **Files Added**: `_layouts/sitemap-collection.html`, enhanced navigation data files
|
|
80
|
+
- **Files Modified**: Main navigation configuration, sitemap pages
|
|
81
|
+
- **Performance**: Optimized DOM manipulation and content rendering
|
|
82
|
+
- **Accessibility**: Full screen reader support and keyboard navigation
|
|
83
|
+
|
|
84
|
+
**Full Documentation**: [v0.5.0 Release Summary](docs/releases/v0.5.0-release-summary.md)
|
|
85
|
+
|
|
86
|
+
## [0.4.0] - 2025-10-10
|
|
18
87
|
|
|
19
88
|
### Added
|
|
20
89
|
- **📊 Comprehensive Site Statistics Dashboard**: Complete analytics system for content insights
|
|
21
90
|
- Dynamic statistics generation from site content using Ruby script
|
|
22
|
-
- Real-time analytics showing
|
|
91
|
+
- Real-time analytics showing content pieces, categories, tags, and word counts
|
|
23
92
|
- Interactive Bootstrap 5-based dashboard with responsive design
|
|
24
93
|
- Modular component architecture with 6 specialized statistics components
|
|
25
94
|
- Intelligent activity level calculations based on actual data distribution
|
|
@@ -54,6 +123,40 @@
|
|
|
54
123
|
- Eliminated type conversion errors in sorting operations
|
|
55
124
|
- Proper handling of nested array data structures
|
|
56
125
|
|
|
126
|
+
**Full Documentation**: [v0.4.0 Release Summary](docs/releases/v0.4.0-release-summary.md)
|
|
127
|
+
|
|
128
|
+
## [0.3.0] - 2025-01-27
|
|
129
|
+
|
|
130
|
+
### Added
|
|
131
|
+
- **🎨 Mermaid Diagram Integration v2.0**: Comprehensive diagramming system
|
|
132
|
+
- Complete diagram support: flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, Gantt charts, pie charts, git graphs, journey diagrams, and mindmaps
|
|
133
|
+
- GitHub Pages compatibility with both local development and deployment
|
|
134
|
+
- Conditional loading for performance optimization
|
|
135
|
+
- Responsive design with automatic scaling across devices
|
|
136
|
+
- Dark mode support with forest theme optimization
|
|
137
|
+
- **📚 Comprehensive Documentation**: Complete user and developer guides
|
|
138
|
+
- Step-by-step user guide with live examples
|
|
139
|
+
- Developer-focused integration tutorial
|
|
140
|
+
- Live test suite with validation examples
|
|
141
|
+
- Comprehensive troubleshooting guide
|
|
142
|
+
- **🧪 Automated Testing Framework**: Complete validation system
|
|
143
|
+
- 16 automated tests covering all aspects
|
|
144
|
+
- Multiple test modes: quick, local, Docker, headless
|
|
145
|
+
- Cross-browser compatibility testing
|
|
146
|
+
- Performance validation and benchmarking
|
|
147
|
+
|
|
148
|
+
### Changed
|
|
149
|
+
- **📁 File Organization**: 53% reduction from 15 to 7 Mermaid-related files
|
|
150
|
+
- **🏗️ Architecture**: Modular include system with clear responsibilities
|
|
151
|
+
- **📖 Documentation**: Consolidated and improved documentation structure
|
|
152
|
+
|
|
153
|
+
### Fixed
|
|
154
|
+
- **🔧 Configuration**: Enhanced Jekyll and GitHub Pages compatibility
|
|
155
|
+
- **⚡ Performance**: Optimized loading and rendering speed
|
|
156
|
+
- **🎯 Usability**: Improved setup process and error handling
|
|
157
|
+
|
|
158
|
+
**Full Documentation**: [v0.3.0 Release Notes](docs/releases/v0.3.0-release-notes.md)
|
|
159
|
+
|
|
57
160
|
## [0.2.1] - 2025-09-30
|
|
58
161
|
|
|
59
162
|
### Added
|
|
@@ -73,32 +176,7 @@
|
|
|
73
176
|
## [0.2.0] - 2025-09-01
|
|
74
177
|
|
|
75
178
|
### Changed
|
|
76
|
-
- Version bump to 0.2.0
|
|
77
|
-
|
|
78
|
-
# Changelog
|
|
79
|
-
|
|
80
|
-
All notable changes to this project will be documented in this file.
|
|
81
|
-
|
|
82
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
83
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
84
|
-
|
|
85
|
-
## [Unreleased]
|
|
86
|
-
|
|
87
|
-
### Added
|
|
88
|
-
- Version control best practices implementation
|
|
89
|
-
- Ruby-standard version management with `lib/jekyll-theme-zer0/version.rb`
|
|
90
|
-
- Enhanced gemspec with proper metadata and security settings
|
|
91
|
-
- Comprehensive version control instructions file
|
|
92
|
-
|
|
93
|
-
### Changed
|
|
94
|
-
- Migrated from package.json to Ruby version file for version management
|
|
95
|
-
- Updated GitHub Actions workflows to use Ruby version file
|
|
96
|
-
- Enhanced gemspec with proper metadata and constraints
|
|
97
|
-
- Improved version bump script to follow Ruby standards
|
|
98
|
-
|
|
99
|
-
### Fixed
|
|
100
|
-
- Version management now follows Ruby gem conventions
|
|
101
|
-
- Gemspec security and metadata improvements
|
|
179
|
+
- Version bump to 0.2.0 with improvements
|
|
102
180
|
|
|
103
181
|
## [0.1.9] - 2025-01-27
|
|
104
182
|
|
|
@@ -109,13 +187,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
109
187
|
- Self-healing `_config_dev.yml` generation for Docker compatibility
|
|
110
188
|
- Enhanced `install.sh` with Docker-first optimization functions
|
|
111
189
|
- Comprehensive Docker troubleshooting and platform detection
|
|
112
|
-
|
|
113
190
|
- **🧠 AI-Powered Self-Healing Configuration**: Intelligent automation and error recovery
|
|
114
191
|
- Auto-detection and resolution of Jekyll theme dependency issues
|
|
115
192
|
- Intelligent platform-specific optimizations (Intel/Apple Silicon)
|
|
116
193
|
- Automatic generation of Docker-compatible development configurations
|
|
117
194
|
- Smart error recovery with detailed logging and guidance
|
|
118
|
-
|
|
119
195
|
- **🚀 Enhanced Installation System**: Robust, error-tolerant setup process
|
|
120
196
|
- `optimize_development_config()` function for Docker-friendly configs
|
|
121
197
|
- `fix_content_issues()` function to resolve Jekyll include problems
|
|
@@ -133,7 +209,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
133
209
|
- Commented out problematic Jekyll includes in README.md
|
|
134
210
|
- Disabled `remote_theme` in development configuration
|
|
135
211
|
- Added essential Jekyll plugins for Docker compatibility
|
|
136
|
-
|
|
137
212
|
- **🍎 Apple Silicon Compatibility**: Fixed Docker platform issues
|
|
138
213
|
- Added `platform: linux/amd64` for Apple Silicon compatibility
|
|
139
214
|
- Automatic platform detection and optimization
|
|
@@ -142,13 +217,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
142
217
|
## [0.1.8] - 2025-01-03
|
|
143
218
|
|
|
144
219
|
### Added
|
|
145
|
-
- **Comprehensive Gem Automation System**: Unified automation ecosystem
|
|
146
|
-
- Complete documentation consolidation following IT-Journey principles (DFF, DRY, KIS, AIPD)
|
|
220
|
+
- **Comprehensive Gem Automation System**: Unified automation ecosystem
|
|
147
221
|
- Zero-click releases with multi-environment testing
|
|
148
222
|
- Production-ready CI/CD pipeline with GitHub Actions integration
|
|
149
223
|
- Semantic versioning, building, testing, and publishing automation
|
|
150
|
-
|
|
151
|
-
- **Remote Installation Support**: Direct installation from GitHub
|
|
224
|
+
- Complete documentation consolidation following IT-Journey principles
|
|
225
|
+
- **Remote Installation Support**: Direct installation from GitHub
|
|
152
226
|
- **Azure Static Web Apps Integration**: Automatic workflow creation for Azure deployment
|
|
153
227
|
- **Build Directory Structure**: Added `build/` directory for logs and temporary files
|
|
154
228
|
- **Enhanced Error Handling**: Comprehensive error handling with colored output
|
|
@@ -156,33 +230,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
156
230
|
|
|
157
231
|
### Changed
|
|
158
232
|
- **Feature Documentation Restructure**: Consolidated redundant automation feature entries
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
- **Simplified Installation Process**: Updated `zer0.md` to use single install command instead of complex manual setup
|
|
164
|
-
- **Azure-Ready Configuration**: Pre-configured directory structure for Azure Static Web Apps (app location: `.`, api location: `api/`, output location: `_site/`)
|
|
165
|
-
- **Enhanced Documentation**: Updated `INSTALLATION.md` with Azure deployment instructions
|
|
166
|
-
- **Improved Help System**: Added remote installation examples to help output
|
|
233
|
+
- **Simplified Installation Process**: Updated to use single install command
|
|
234
|
+
- **Azure-Ready Configuration**: Pre-configured directory structure for Azure Static Web Apps
|
|
235
|
+
- **Enhanced Documentation**: Updated with Azure deployment instructions
|
|
236
|
+
- **Improved Help System**: Added remote installation examples
|
|
167
237
|
|
|
168
238
|
### Removed
|
|
169
239
|
- **Redundant Documentation**: Eliminated duplicate automation documentation files
|
|
170
|
-
- Removed `AUTOMATION_SUMMARY.md` (content merged into comprehensive feature)
|
|
171
|
-
- Removed `automated-version-build-system.md` (superseded by comprehensive version)
|
|
172
|
-
- Consolidated 6 separate automation entries into 1 comprehensive feature
|
|
173
240
|
|
|
174
241
|
### Fixed
|
|
175
|
-
- **Installation Script Compatibility**: Made
|
|
176
|
-
- **Directory Structure**: Optimized for Azure Static Web Apps deployment
|
|
242
|
+
- **Installation Script Compatibility**: Made compatible with both local and remote execution
|
|
243
|
+
- **Directory Structure**: Optimized for Azure Static Web Apps deployment
|
|
177
244
|
- **Markdown Lint Issues**: Fixed all markdown formatting violations
|
|
178
|
-
- Proper heading spacing and structure
|
|
179
|
-
- Fixed bare URLs with angle bracket notation
|
|
180
|
-
- Removed trailing spaces and improved table formatting
|
|
181
245
|
|
|
182
246
|
## [0.1.7] - 2024-12-01
|
|
183
247
|
|
|
184
248
|
### Added
|
|
185
|
-
- Bootstrap Jekyll theme for headless
|
|
249
|
+
- Bootstrap Jekyll theme for headless GitHub Pages CMS
|
|
186
250
|
- Basic theme structure with layouts, includes, and assets
|
|
187
251
|
- Jekyll compatibility with GitHub Pages
|
|
188
252
|
- Scripts for version management, build, and test automation
|
|
@@ -194,7 +258,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
194
258
|
|
|
195
259
|
---
|
|
196
260
|
|
|
197
|
-
|
|
261
|
+
## Documentation
|
|
262
|
+
|
|
263
|
+
For detailed documentation on features, systems, and configuration:
|
|
264
|
+
- **[Documentation Center](docs/README.md)** - Complete documentation overview
|
|
265
|
+
- **[Release Documentation](docs/releases/README.md)** - Historical release information
|
|
266
|
+
- **[Feature Documentation](docs/features/README.md)** - Detailed feature guides
|
|
267
|
+
- **[System Documentation](docs/systems/README.md)** - Core systems and automation
|
|
268
|
+
- **[Configuration Guides](docs/configuration/README.md)** - Setup and configuration
|
|
269
|
+
|
|
270
|
+
## Links
|
|
271
|
+
|
|
272
|
+
[Unreleased]: https://github.com/bamr87/zer0-mistakes/compare/v0.5.0...HEAD
|
|
273
|
+
[0.5.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.4.0...v0.5.0
|
|
274
|
+
[0.4.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.3.0...v0.4.0
|
|
275
|
+
[0.3.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.2.1...v0.3.0
|
|
276
|
+
[0.2.1]: https://github.com/bamr87/zer0-mistakes/compare/v0.2.0...v0.2.1
|
|
277
|
+
[0.2.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.9...v0.2.0
|
|
198
278
|
[0.1.9]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.8...v0.1.9
|
|
199
279
|
[0.1.8]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.7...v0.1.8
|
|
200
280
|
[0.1.7]: https://github.com/bamr87/zer0-mistakes/releases/tag/v0.1.7
|
data/README.md
CHANGED
|
@@ -133,6 +133,15 @@ docker-compose up
|
|
|
133
133
|
- **SEO Optimized** - Built-in meta tags, structured data, and social sharing
|
|
134
134
|
- **Performance Focused** - Optimized loading, caching, and Core Web Vitals
|
|
135
135
|
|
|
136
|
+
### 📊 **Privacy-First Analytics & Tracking**
|
|
137
|
+
|
|
138
|
+
- **PostHog Integration** - Advanced analytics with privacy controls and GDPR/CCPA compliance
|
|
139
|
+
- **Cookie Consent Management** - Granular user permissions with persistent preferences
|
|
140
|
+
- **Custom Event Tracking** - Jekyll-specific events (downloads, navigation, reading engagement)
|
|
141
|
+
- **Development Safety** - Analytics disabled in development environment
|
|
142
|
+
- **User Privacy Controls** - Respect Do Not Track, opt-out mechanisms, data anonymization
|
|
143
|
+
- **Comprehensive Insights** - Page views, user journeys, content engagement, and performance metrics
|
|
144
|
+
|
|
136
145
|
### 🌐 **Deployment Ready**
|
|
137
146
|
|
|
138
147
|
- **GitHub Pages** - Zero-config deployment with remote theme
|
|
@@ -149,6 +158,17 @@ docker-compose up
|
|
|
149
158
|
- **GitHub Releases** - Creates comprehensive release pages with assets
|
|
150
159
|
- **CI/CD Integration** - Seamless automation with GitHub Actions
|
|
151
160
|
|
|
161
|
+
### ℹ️ **Automatic Theme Version Display**
|
|
162
|
+
|
|
163
|
+
- **Zero Configuration** - Theme version displays automatically, no hardcoding needed
|
|
164
|
+
- **System Information** - Shows Jekyll, Ruby, and build environment details
|
|
165
|
+
- **Always Accessible** - Info modal available from header (⚙️) and footer on every page
|
|
166
|
+
- **Dynamic Extraction** - Version pulled from gem specification during build
|
|
167
|
+
- **Comprehensive Details** - Lists active plugins, technology stack, and helpful links
|
|
168
|
+
- **GitHub Pages Compatible** - Works with both local gems and remote themes
|
|
169
|
+
|
|
170
|
+
[Learn more about the Theme Version Feature →](docs/THEME_VERSION_FEATURE.md)
|
|
171
|
+
|
|
152
172
|
> 📖 **Learn more**: [Automated Version System Documentation](AUTOMATED_VERSION_SYSTEM.md)
|
|
153
173
|
|
|
154
174
|
### 📊 **Mermaid Diagram Integration** *(New in v0.3.0)*
|
|
@@ -163,6 +183,63 @@ docker-compose up
|
|
|
163
183
|
|
|
164
184
|
> 📖 **Learn more**: [Mermaid Documentation](/docs/jekyll/mermaid/) • [Integration Tutorial](/docs/jekyll/jekyll-diagram-with-mermaid/) • [Test Suite](/docs/jekyll/mermaid-test-suite/)
|
|
165
185
|
|
|
186
|
+
## 📚 Documentation Architecture
|
|
187
|
+
|
|
188
|
+
Zer0-Mistakes features a **dual documentation structure** designed for different audiences and use cases:
|
|
189
|
+
|
|
190
|
+
### 🛠️ **Technical Documentation** → [`/docs/`](docs/)
|
|
191
|
+
**Repository-specific technical documentation** (MDX format) for developers and contributors:
|
|
192
|
+
|
|
193
|
+
| Directory | Purpose | Target Audience |
|
|
194
|
+
|-----------|---------|----------------|
|
|
195
|
+
| [`/docs/systems/`](docs/systems/) | Infrastructure automation, CI/CD, build processes | DevOps & Contributors |
|
|
196
|
+
| [`/docs/features/`](docs/features/) | Theme feature implementation, component architecture | Developers & Maintainers |
|
|
197
|
+
| [`/docs/configuration/`](docs/configuration/) | Development setup, Docker, environment configuration | Contributors |
|
|
198
|
+
| [`/docs/releases/`](docs/releases/) | Version history, migration guides, technical changes | All Technical Users |
|
|
199
|
+
| [`/docs/jekyll/`](docs/jekyll/) | Jekyll optimization, plugins, advanced configuration | Jekyll Developers |
|
|
200
|
+
|
|
201
|
+
**Key characteristics:**
|
|
202
|
+
- **MDX format** with interactive components and rich code examples
|
|
203
|
+
- **Source code focused** with direct references to `_layouts/`, `_includes/`, `scripts/`
|
|
204
|
+
- **Architecture documentation** explaining how features are built and maintained
|
|
205
|
+
- **Developer workflows** including testing, deployment, and contribution guidelines
|
|
206
|
+
|
|
207
|
+
### 📖 **Public Documentation** → [`/pages/_docs/`](pages/_docs/)
|
|
208
|
+
**Published online documentation** (Markdown format) for end-users and general developers:
|
|
209
|
+
|
|
210
|
+
| Content Type | Purpose | Source |
|
|
211
|
+
|--------------|---------|--------|
|
|
212
|
+
| **Technology Guides** | General Jekyll, Bootstrap, Ruby documentation | Imported & curated external docs |
|
|
213
|
+
| **User Tutorials** | How to use and customize the theme | Original content for users |
|
|
214
|
+
| **Reference Materials** | API docs, configuration options, troubleshooting | Converted from technical docs |
|
|
215
|
+
| **External Imports** | Official documentation from Jekyll, Bootstrap, etc. | Git submodules & processing scripts |
|
|
216
|
+
|
|
217
|
+
**Key characteristics:**
|
|
218
|
+
- **Markdown format** optimized for Jekyll rendering and online consumption
|
|
219
|
+
- **User-focused** content targeting theme adopters and general developers
|
|
220
|
+
- **Processed content** converted from MDX sources and external documentation
|
|
221
|
+
- **Published online** at [zer0-mistakes.org/docs](https://bamr87.github.io/zer0-mistakes/docs/)
|
|
222
|
+
|
|
223
|
+
### 🔄 **Content Flow & Conversion**
|
|
224
|
+
|
|
225
|
+
```mermaid
|
|
226
|
+
graph LR
|
|
227
|
+
A[Technical Docs<br/>/docs/ *.mdx] --> B[Processing Scripts]
|
|
228
|
+
B --> C[Public Docs<br/>/pages/_docs/ *.md]
|
|
229
|
+
D[External Docs<br/>Jekyll, Bootstrap] --> E[Import Scripts]
|
|
230
|
+
E --> C
|
|
231
|
+
C --> F[Jekyll Build]
|
|
232
|
+
F --> G[Published Site]
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
**Documentation Workflow:**
|
|
236
|
+
1. **Technical implementation** documented in `/docs/` using MDX for rich content
|
|
237
|
+
2. **Processing pipeline** converts and sanitizes content for public consumption
|
|
238
|
+
3. **External documentation** imported from official sources and integrated
|
|
239
|
+
4. **Jekyll rendering** builds and serves final documentation site
|
|
240
|
+
|
|
241
|
+
> **📍 Quick Navigation**: [Technical Docs](docs/) • [Public Documentation](pages/_docs/) • [GitHub Copilot Instructions](.github/instructions/) • [Contributing Guidelines](CONTRIBUTING.md)
|
|
242
|
+
|
|
166
243
|
## 📋 Prerequisites
|
|
167
244
|
|
|
168
245
|
Before you begin, ensure you have:
|
|
@@ -604,7 +681,31 @@ git commit -m "Add amazing feature"
|
|
|
604
681
|
git push origin feature/amazing-feature
|
|
605
682
|
```
|
|
606
683
|
|
|
607
|
-
##
|
|
684
|
+
## � Documentation
|
|
685
|
+
|
|
686
|
+
### 📖 Comprehensive Documentation Center
|
|
687
|
+
All documentation is organized in the [`docs/`](docs/README.md) directory:
|
|
688
|
+
|
|
689
|
+
- **[📋 Documentation Overview](docs/README.md)** - Complete documentation center with organized structure
|
|
690
|
+
- **[🚀 Release Documentation](docs/releases/README.md)** - Version history and release notes
|
|
691
|
+
- **[⭐ Feature Documentation](docs/features/README.md)** - Detailed feature guides and implementation
|
|
692
|
+
- **[⚙️ System Documentation](docs/systems/README.md)** - Core systems, automation, and CI/CD
|
|
693
|
+
- **[🔧 Configuration Guides](docs/configuration/README.md)** - Setup and hosting configuration
|
|
694
|
+
- **[📝 Documentation Templates](docs/templates/README.md)** - Standardized templates for consistent documentation
|
|
695
|
+
|
|
696
|
+
### 📊 Recent Releases
|
|
697
|
+
- **[v0.5.0](docs/releases/v0.5.0-release-summary.md)** - Comprehensive Sitemap Integration (Latest)
|
|
698
|
+
- **[v0.4.0](docs/releases/v0.4.0-release-summary.md)** - Statistics Dashboard
|
|
699
|
+
- **[v0.3.0](docs/releases/v0.3.0-release-notes.md)** - Mermaid Integration v2.0
|
|
700
|
+
|
|
701
|
+
### 🌟 Key Features
|
|
702
|
+
- **[Sitemap Integration](docs/features/sitemap-integration.md)** - Unified site navigation and content discovery
|
|
703
|
+
- **[Automated Version System](docs/systems/automated-version-system.md)** - Intelligent release automation
|
|
704
|
+
- **[CI/CD Pipeline](docs/systems/cicd-status-report.md)** - Comprehensive testing and deployment
|
|
705
|
+
- **[URL Configuration](docs/configuration/url-configuration-guide.md)** - Multi-hosting setup guide
|
|
706
|
+
- **[GitHub Copilot Instructions](.github/instructions/README.md)** - AI-assisted development with comprehensive coding guidelines
|
|
707
|
+
|
|
708
|
+
## �📄 License
|
|
608
709
|
|
|
609
710
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
610
711
|
|