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.
๐ Quick Links#
- Main README - Project overview and features
- Environment Example - Environment variable template
- Theme Config - Central theme configuration
๐ 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:
- Create a new
.mdfile in this directory - Add it to the "Available Documentation" section above
- Use clear headings and examples
- Include a table of contents for longer documents
- Link to related documentation where relevant