my website at ewancroft.uk

feat: update documentation structure and add configuration guide for better user onboarding

ewancroft.uk cf58966d f6667184

verified
+3 -3
CONFIGURATION.md docs/configuration.md
··· 656 656 If you encounter issues not covered here: 657 657 658 658 1. **Check Browser Console**: Press F12 and look for error messages 659 - 2. **Review README**: See [README.md](./README.md) for detailed feature documentation 659 + 2. **Review README**: See [README.md](../README.md) for detailed feature documentation 660 660 3. **GitHub Issues**: Search existing issues or create a new one 661 661 4. **AT Protocol Docs**: Visit [atproto.com](https://atproto.com/) for protocol details 662 662 5. **SvelteKit Docs**: Check [kit.svelte.dev](https://kit.svelte.dev/) for framework help ··· 699 699 - Add site information via AT Protocol records 700 700 701 701 2. **Deploy Your Site**: 702 - - See [README.md](./README.md#-deployment) for deployment options 702 + - See [README.md](../README.md#-deployment) for deployment options 703 703 - Choose a platform (Vercel, Netlify, Cloudflare Pages, etc.) 704 704 - Configure production environment variables 705 705 - Set up custom domain ··· 764 764 765 765 --- 766 766 767 - **Configuration complete!** Your AT Protocol-powered personal website is ready to use. For detailed feature documentation, see [README.md](./README.md). 767 + **Configuration complete!** Your AT Protocol-powered personal website is ready to use. For detailed feature documentation, see [README.md](../README.md).
+3 -3
README.md
··· 2 2 3 3 A modern, feature-rich personal website powered by AT Protocol, built with SvelteKit 2 and Tailwind CSS 4. 4 4 5 - > **Note**: This repository contains the source code for [Ewan's Corner](https://ewancroft.uk). The current configuration (environment variables, slug mappings, static files) is specific to that website, but the codebase is designed to be easily adapted for your own AT Protocol-powered site. See [CONFIGURATION.md](./CONFIGURATION.md) for detailed setup instructions. 5 + > **Note**: This repository contains the source code for [Ewan's Corner](https://ewancroft.uk). The current configuration (environment variables, slug mappings, static files) is specific to that website, but the codebase is designed to be easily adapted for your own AT Protocol-powered site. See [Configuration Guide](./docs/configuration.md) for detailed setup instructions. 6 6 7 7 ## ๐ŸŒŸ Features 8 8 ··· 95 95 96 96 ## ๐Ÿ“‹ Configuration 97 97 98 - For detailed configuration instructions, see [CONFIGURATION.md](./CONFIGURATION.md). 98 + For detailed configuration instructions, see the [Configuration Guide](./docs/configuration.md). 99 99 100 100 Quick start: 101 101 ··· 132 132 cp .env .env.local 133 133 ``` 134 134 135 - Edit `.env.local` with your settings (see [CONFIGURATION.md](./CONFIGURATION.md) for details) 135 + Edit `.env.local` with your settings (see [Configuration Guide](./docs/configuration.md) for details) 136 136 137 137 4. **Configure publication slugs** in `src/lib/config/slugs.ts` 138 138
+56
docs/README.md
··· 1 + # Documentation 2 + 3 + Welcome to the project documentation! This directory contains all technical documentation for the AT Protocol-powered personal website. 4 + 5 + ## ๐Ÿ“š Available Documentation 6 + 7 + ### [Configuration Guide](./configuration.md) 8 + Complete setup and configuration guide for your personal website. Covers: 9 + - Environment variables setup 10 + - Publication slug mapping 11 + - Static file customization 12 + - Optional features (WhiteWind, CORS, etc.) 13 + - Troubleshooting common issues 14 + 15 + **Start here if you're setting up the site for the first time.** 16 + 17 + ### [Theme System](./theme-system.md) 18 + Documentation for the centralized color theme system. Learn how to: 19 + - Add new color themes 20 + - Customize existing themes 21 + - Understand the theme architecture 22 + - Use the theme configuration API 23 + 24 + **Read this if you want to customize or add color themes.** 25 + 26 + ## ๐Ÿš€ Quick Links 27 + 28 + - [Main README](../README.md) - Project overview and features 29 + - [Environment Example](../.env.example) - Environment variable template 30 + - [Theme Config](../src/lib/config/themes.config.ts) - Central theme configuration 31 + 32 + ## ๐Ÿ“– Documentation Structure 33 + 34 + ``` 35 + docs/ 36 + โ”œโ”€โ”€ README.md # This file - documentation index 37 + โ”œโ”€โ”€ configuration.md # Setup and configuration guide 38 + โ””โ”€โ”€ theme-system.md # Theme system documentation 39 + ``` 40 + 41 + ## ๐Ÿ’ก Contributing to Documentation 42 + 43 + When adding new documentation: 44 + 45 + 1. Create a new `.md` file in this directory 46 + 2. Add it to the "Available Documentation" section above 47 + 3. Use clear headings and examples 48 + 4. Include a table of contents for longer documents 49 + 5. Link to related documentation where relevant 50 + 51 + ## ๐Ÿ”— External Resources 52 + 53 + - [AT Protocol Documentation](https://atproto.com/) 54 + - [SvelteKit Documentation](https://kit.svelte.dev/) 55 + - [Tailwind CSS Documentation](https://tailwindcss.com/) 56 + - [Bluesky](https://bsky.app/)
src/lib/config/THEME_SYSTEM.md docs/theme-system.md