Welcome to the comprehensive documentation for Jermaine's Spotify Time Machine. This documentation follows the Diátaxis framework for clear, organized technical documentation.
Our documentation is organized into four categories to help you find what you need:
Learning-oriented: Step-by-step lessons to help you get started
Coming soon: Getting started tutorials will be added as the project evolves.
Problem-oriented: Step-by-step guides to solve specific problems
- Badge Management - How to manage and update README badges automatically
- Badge Implementation Summary - Summary of badge system implementation
- Vercel Deployment Fixes - How to fix common Vercel deployment issues
- Vercel DotEnvx Fix - How to configure environment variables in Vercel
Information-oriented: Technical descriptions and specifications
- Command Reference - Quick reference for all development commands
- Developer Tools - Complete reference for all development tools and utilities
- Tool Installation - Tool installation notes and requirements
- Branding Guidelines - Spotify branding and design system guidelines
Understanding-oriented: Conceptual guides to deepen your knowledge
- Token Management Architecture - Comprehensive guide to authentication and token management system
- Analytics Architecture - Overview of analytics and monitoring implementation
- Implementation Summary - High-level summary of key implementations
- DevOps Improvements - Summary of developer experience and DevOps enhancements
- DevOps Infrastructure - Detailed infrastructure and tooling setup
- Domain Migration Strategy - Strategy for domain migration
- Dependency Migration 2025 - Breaking changes and migration guide for 2025 dependency updates
- Oxlint Migration - Migration from ESLint to Oxlint for improved performance
- Documentation Reorganization - Summary of Diátaxis framework application and documentation restructuring
- README.md - Project overview and quick start guide
- TODO.md - Feature implementation checklist and development priorities
- CLAUDE.md - AI assistant context and development guidelines
- LLM_CONTEXT.md - Large language model context for code generation
- Start with the README for project overview
- Review CLAUDE.md for development patterns
- Check Command Reference for quick commands
- Read Developer Tools for tooling setup
- Quick Commands: Command Reference
- Tool Setup: Developer Tools
- Architecture: Token Management Architecture
- Current Tasks: TODO.md
- Vercel Issues: Vercel Deployment Fixes
- Environment Setup: Vercel DotEnvx Fix
- Domain Migration: Domain Migration Strategy
- Implementation Overview: Implementation Summary
- Recent Changes: DevOps Improvements
- Migration History: Dependency Migration 2025
This documentation follows the Diátaxis framework which organizes content into four distinct categories:
- Tutorials - Learning by doing (practical steps for beginners)
- How-To Guides - Achieving specific goals (recipes for experts)
- Reference - Technical information (accurate and complete specifications)
- Explanation - Understanding concepts (background and context)
For more information about this framework, visit diataxis.fr.
When adding new documentation:
- Identify the category: Is it a tutorial, how-to guide, reference, or explanation?
- Use kebab-case: Name files with lowercase and hyphens (e.g.,
token-management.md) - Keep it focused: Each document should cover one topic thoroughly
- Cross-reference: Link to related documents in other categories
- Update this index: Add your new document to the appropriate section
If you find gaps in the documentation or have suggestions for improvement:
- Check the TODO.md for planned improvements
- Review existing documentation for answers
- Consider contributing documentation improvements
- Follow the Diátaxis framework for new content
Last updated: October 2025 Documentation framework: Diátaxis