📚 Idling.app Documentation
Welcome to the co-located documentation for Idling.app! This documentation lives right alongside the source code, ensuring it stays up-to-date and accurate.
🚀 What You'll Find Here
📖 Co-located Documentation
All documentation files are stored directly with the relevant source code:
- API documentation lives in
src/app/api/*/index.md - Component documentation is alongside each React component
- Feature documentation is organized by functionality
🔌 Interactive API Documentation
Explore our REST API with live examples and testing capabilities:
- Full OpenAPI specification with interactive playground
- Live API testing - try endpoints directly from the docs
- Authentication examples and error handling
🎨 Design System
Learn about our design patterns, components, and styling approach:
- Component library with live examples
- Color system and brand guidelines
- Layout patterns and responsive design
🗂️ Navigation
| Section | Description |
|---|---|
| API Reference | Complete REST API documentation with interactive examples |
| Components | React component documentation and usage examples |
| Features | High-level feature documentation and user guides |
| Development | Setup guides, architecture decisions, and contributing |
🔥 Features of This Documentation
- 📍 Co-located: Documentation lives with the code it describes
- 🔄 Live Reload: Updates automatically as you edit source files
- 🧪 Interactive: Test API endpoints directly in the browser
- 🎯 Searchable: Full-text search across all documentation
- 📱 Responsive: Works perfectly on mobile and desktop
- 🎨 Themed: Matches the main application's design system
🛠️ Quick Start
- Browse API docs: Start with our API Overview
- Explore components: Check out the Component Library
- Understand features: Read about Core Features
- Set up development: Follow the Setup Guide
This documentation is powered by Docusaurus with co-located markdown files and live OpenAPI integration.