Skip to content

About This Documentation

Purpose

This documentation provides comprehensive information about Chris Lyons' personal website — a modern, performant portfolio built with cutting-edge web technologies.

Target Audience

For Users

Learn about the site's features, architecture, and capabilities.

For Developers

Understand the technical implementation and deploy your own version.

For Contributors

Get started with development and contribute improvements.

Documentation Structure

Getting Started

Quick start guides for setting up and running the project locally.

  • Installation
  • Quick Start
  • Configuration

Features

Detailed information about site features and capabilities.

  • Overview
  • Tech Stack
  • Performance
  • Accessibility

Architecture

Deep dives into system design and architecture decisions.

  • Overview
  • System Design
  • Dependencies

Deployment

Guides for deploying to production environments.

  • Overview
  • Vercel
  • GitHub Pages

Component Reference

Component usage examples and patterns.

Contributing to Docs

Reporting Issues

Found an error? Open an issue

Suggesting Improvements

Have ideas for better documentation? We'd love to hear them!

Contributing Changes

  1. Fork the repository
  2. Edit files in docs/
  3. Submit a pull request

Documentation Stack

This documentation is built with:

  • MkDocs - Static site generator
  • Material for MkDocs - Theme
  • Mermaid - Diagrams
  • Pygments - Syntax highlighting
  • GitHub Pages - Hosting

Local Development

# Install MkDocs
pip install mkdocs-material

# Serve locally
mkdocs serve

# Build
mkdocs build

License

This documentation is licensed under the MIT License.

Contact

Version

Documentation Version: 1.0.0 Last Updated: 2024-10-04

This documentation is continuously improved. Check back often for updates!