ewancroft.uk / website
my website at ewancroft.uk
fork

Configure Feed

Select the types of activity you want to include in your feed.

website / docs / README.md
at main 3.1 kB view raw view code
ewancroft.uk style: format codebase with Prettier
caff2b67

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.

Standard.site Integration#

Complete guide to the Standard.site lexicons integration. Covers:

  • Overview of Standard.site lexicon collections
  • Type definitions and API reference
  • Fetching publications and documents
  • Slug-based routing configuration
  • Blog feed integration
  • URL resolution patterns
  • Troubleshooting and examples

Read this if you want to use Standard.site for long-form content.

Quick References:

🚀 Quick Links#

📖 Documentation Structure#

docs/
├── README.md                        # This file - documentation index
├── configuration.md                 # Setup and configuration guide
├── theme-system.md                  # Theme system documentation
├── standard-site-integration.md     # Standard.site integration guide
├── INTEGRATION_SUMMARY.md           # Standard.site changes summary
├── STANDARD_SITE_QUICK_REF.md       # Standard.site quick reference
└── MIGRATION_GUIDE.md               # Leaflet to Standard.site migration

💡 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#