Skip to content

Developer Documentation

Technical documentation for contributors and maintainers of the Zer0-Mistakes Jekyll theme.

Purpose

This /docs/ directory contains developer-focused documentation for the Zer0-Mistakes Jekyll theme:

  • Architecture — Codebase structure and design decisions
  • Systems — CI/CD, release automation, gem publication
  • Implementation — Feature implementation details and changelogs
  • Development — Setup guides and coding conventions
  • Releases — Version history and release notes

For Users: If you're looking for documentation on using the theme — installation, features, customization, deployment — see pages/_docs/, which is the user-facing documentation site (served at /docs/ on the live theme). This docs/ directory is for contributors and maintainers only.

Directory Structure

docs/
├── README.md                  # This file
│
├── ui/                        # Theme styling and component reference
│   ├── design-system.md
│   ├── design-tokens.md
│   ├── theming.md
│   ├── configuration.md
│   ├── components.md
│   ├── layouts-and-navigation.md
│   ├── code-blocks.md
│   ├── customization.md
│   ├── extending.md
│   └── js-api.md
│
├── architecture/              # ADRs and system design
│   ├── prd-requirements.md
│   ├── prd-roadmap.md
│   ├── project-structure.md
│   ├── layouts-includes.md
│   └── build-system.md
│
├── development/               # Contributor setup and conventions
│   ├── local-setup.md
│   ├── testing.md
│   ├── code-style.md
│   ├── troubleshooting.md
│   └── documentation-workflow.md
│
├── systems/                   # Infrastructure and CI/CD
│   ├── release-automation.md
│   ├── automated-version-system.md
│   ├── gem-publication-system.md
│   ├── dependency-management.md
│   ├── ruby-version-management.md
│   └── github-secrets-setup.md
│
├── implementation/            # Feature implementation changelogs
│   ├── feature-change-log.md
│   ├── navigation-redesign.md
│   ├── posthog-analytics-integration.md
│   ├── preview-image-generator.md
│   └── sitemap-integration.md
│
├── features/                  # Per-feature design notes
│   ├── jupyter-notebooks.md
│   ├── nanobar-component.md
│   └── theme-version.md
│
├── installation/              # Installer and deployment guides
│   ├── index.md
│   ├── forking.md
│   ├── url-configuration.md
│   ├── profiles.md
│   ├── ai-features.md
│   ├── deploy-targets.md
│   ├── customization.md
│   ├── architecture.md
│   └── migration-from-0.x.md
│
├── releases/                  # Release notes by version
│   └── v*.md
│
├── templates/                 # Documentation templates
│   ├── feature-documentation-template.md
│   ├── release-notes-template.md
│   └── change-tracking-template.md
│
└── archive/                   # Historical / superseded docs

Styling and UI (start here)

Live preview (built site): /about/settings/theme-preview/

Getting Started (Contributors)

Understanding the Codebase

Release Process

Installation and Forking

Features

Systems and Infrastructure

Documentation Locations

Location Purpose Audience
/docs/ (this directory) Developer/contributor documentation Maintainers
/pages/_docs/ User-facing theme documentation End users
README.md Project overview All users
CONTRIBUTING.md Contribution guidelines Contributors

Recent Updates

  • May 2026 — All root-level docs moved into subdirectories; ui/ created for styling reference; DOCUMENTATION_WORKFLOW.md moved to development/
  • v1.8 — Comprehensive styling documentation set (design system, theming, configuration, components, layouts, code blocks)
  • v0.22.21 — Nanobar component refactoring, footer full-width fix, UI/UX improvements
  • v0.22.0 — Copilot Agent prompt button with data-driven prompt registry
  • v0.6.0 — Release automation modernization

Last Updated: May 2026 Maintained By: Zer0-Mistakes Contributors