Technology	Version
Ruby	`3.2.3`
Jekyll	`3.9.5`
Bootstrap	`5.2.0`
Algolia	—
JQuery	—
MathJax	`1.0`
GitHub Pages	`232`
docker	`20.10.8`

📚 Published Documentation Library

By Amr Abdel Eissa

Public documentation library for technology guides, tutorials, and general reference materials

Estimated reading time: 18 minutes

📚 Zer0-Mistakes Documentation Library

Welcome to the published documentation library for Zer0-Mistakes! This section contains user-facing documentation, tutorials, and general technology guides that are rendered and served online for public consumption.

🎯 Purpose & Scope

The /pages/_docs/ collection serves as the public documentation hub containing:

Technology Guides: General documentation for Jekyll, Bootstrap, Ruby, and other stack technologies
User Tutorials: Step-by-step guides for using and customizing the Zer0-Mistakes theme
Imported Documentation: Cleaned and processed docs from external sources (Jekyll docs, Bootstrap guides)
Reference Materials: API references, configuration guides, and troubleshooting resources
Rendered Content: Markdown files converted from MDX sources for Jekyll processing

This documentation targets end-users, theme adopters, and general developers who want to use or learn about the technologies in our stack.

🛠️ For Technical Documentation: See the repository docs/ folder on GitHub: https://github.com/bamr87/zer0-mistakes/tree/main/docs/

📖 Content Organization

🌟 Current Documentation Collections

🔧 Jekyll Documentation

Comprehensive Jekyll guides sourced from official documentation
Theme-specific customization instructions
Performance optimization and security best practices
Plugin integration and advanced configuration

🎨 Bootstrap & Frontend

Component usage guides and examples
Responsive design patterns and utilities
Custom CSS integration and theme customization
Accessibility and cross-browser compatibility

⚙️ General Technology Stack

Ruby and gem management
Liquid templating language reference
Docker and containerization guides
Git workflows and version control

📝 Content Sources & Processing

This documentation library aggregates content from multiple sources:

Converted MDX Files: Technical documentation from docs/ in the repo: https://github.com/bamr87/zer0-mistakes/tree/main/docs/
Imported External Docs: Official documentation from Jekyll, Bootstrap, and other technologies
Original Tutorials: Theme-specific guides and tutorials written specifically for users
Community Contributions: User-submitted guides and best practices

🔄 Documentation Workflow

📥 Content Import Process

# Import official Jekyll documentation
git submodule add https://github.com/jekyll/jekyll.git jekyll-docs

# Configure sparse checkout for relevant documentation
cd jekyll-docs/docs/_docs
git sparse-checkout init --cone
git sparse-checkout set docs/_docs

🔄 MDX to Markdown Conversion

The documentation processing pipeline:

Source: MDX files in /docs/ with technical implementation details
Processing: Automated conversion removing repository-specific technical details
Cleanup: Sanitization for public consumption and user-focused content
Publication: Processed Markdown files placed in pages/_docs/ for Jekyll rendering

📋 Content Standards

📄 File Format: Standard Markdown (.md) for Jekyll compatibility 🏷️ Front Matter: Complete metadata for proper categorization and navigation 🔗 Cross-References: Links to related guides and external resources 💡 User-Focused: Content written for end-users rather than developers

🚀 Getting Started

📚 Available Documentation

Currently available technology documentation:

Jekyll - Static site generator guides and advanced configuration
Ruby - Ruby language and gem management
Liquid - Templating language reference and examples
Bootstrap - Component library and responsive design patterns
Docker - Containerization and development environment setup

📖 Contributing to Documentation

To add new documentation to this library:

Check Source: Determine if content should be in /docs/ (technical) or pages/_docs/ (public)
Follow Standards: Use proper front matter and Markdown formatting
Test Locally: Verify Jekyll rendering and navigation
Submit PR: Include description of documentation purpose and target audience

🔧 Adding External Documentation

To import external documentation (e.g., official project docs):

# Add as git submodule for version tracking
git submodule add https://github.com/jekyll/jekyll.git jekyll-docs

# Configure sparse checkout for relevant sections
cd jekyll-docs
git sparse-checkout init --cone
git sparse-checkout set docs/_docs

# Process and clean content for integration
# (Custom scripts in /scripts/ handle this workflow)

🌐 Documentation Ecosystem

This documentation library is part of a larger documentation ecosystem:

Location	Purpose	Audience	Format
`pages/_docs/` (This Library)	Public documentation & tutorials	End Users & General Developers	Markdown
`docs/` (GitHub)	Technical repository documentation	Contributors & Maintainers	MDX
`.github/instructions/` (GitHub)	AI-assisted development guidance	GitHub Copilot & Contributors	Markdown
`/README.md`	Project overview & quick start	All Users	Markdown

🎯 Quick Navigation

📚 Browse Jekyll Documentation - Learn Jekyll fundamentals and advanced techniques
🎨 Explore Bootstrap Components - Master responsive design and UI components
⚙️ Technical Implementation - Repository architecture and development guides
🏠 Return to Homepage - Main Zer0-Mistakes theme showcase

Last Updated: November 16, 2025
Maintained By: Zer0-Mistakes Community

Collection Index - docs