my website at ewancroft.uk
ewancroft.uk
1# Documentation
2
3Welcome 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
9Complete setup and configuration guide for your personal website. Covers:
10
11- Environment variables setup
12- Publication slug mapping
13- Static file customization
14- Optional features (WhiteWind, CORS, etc.)
15- Troubleshooting common issues
16
17**Start here if you're setting up the site for the first time.**
18
19### [Theme System](./theme-system.md)
20
21Documentation for the centralized color theme system. Learn how to:
22
23- Add new Colour Themes
24- Customize existing themes
25- Understand the theme architecture
26- Use the theme configuration API
27
28**Read this if you want to customize or add Colour Themes.**
29
30## 🚀 Quick Links
31
32- [Main README](../README.md) - Project overview and features
33- [Environment Example](../.env.example) - Environment variable template
34- [Theme Config](../src/lib/config/themes.config.ts) - Central theme configuration
35
36## 📖 Documentation Structure
37
38```plaintext
39docs/
40├── README.md # This file - documentation index
41├── configuration.md # Setup and configuration guide
42└── theme-system.md # Theme system documentation
43```
44
45## 💡 Contributing to Documentation
46
47When adding new documentation:
48
491. Create a new `.md` file in this directory
502. Add it to the "Available Documentation" section above
513. Use clear headings and examples
524. Include a table of contents for longer documents
535. Link to related documentation where relevant
54
55## 🔗 External Resources
56
57- [AT Protocol Documentation](https://atproto.com/)
58- [SvelteKit Documentation](https://kit.svelte.dev/)
59- [Tailwind CSS Documentation](https://tailwindcss.com/)
60- [Bluesky](https://bsky.app/)