my website at ewancroft.uk
README.md

Documentation#

Welcome to the project documentation! This directory contains all technical documentation for the AT Protocol-powered personal website.

๐Ÿ“š Available Documentation#

Configuration Guide#

Complete setup and configuration guide for your personal website. Covers:

  • Environment variables setup
  • Publication slug mapping
  • Static file customization
  • Optional features (WhiteWind, CORS, etc.)
  • Troubleshooting common issues

Start here if you're setting up the site for the first time.

Theme System#

Documentation for the centralized color theme system. Learn how to:

  • Add new Colour Themes
  • Customize existing themes
  • Understand the theme architecture
  • Use the theme configuration API

Read this if you want to customize or add Colour Themes.

๐Ÿ“– Documentation Structure#

docs/
โ”œโ”€โ”€ README.md           # This file - documentation index
โ”œโ”€โ”€ configuration.md    # Setup and configuration guide
โ””โ”€โ”€ theme-system.md     # Theme system documentation

๐Ÿ’ก Contributing to Documentation#

When adding new documentation:

  1. Create a new .md file in this directory
  2. Add it to the "Available Documentation" section above
  3. Use clear headings and examples
  4. Include a table of contents for longer documents
  5. Link to related documentation where relevant

๐Ÿ”— External Resources#