dashy/docs

Running Dashy

• Quick Start - TLDR guide on getting Dashy up and running
• Deployment - Full guide on deploying Dashy either locally or online
• Configuring - Complete list of all available options in the config file
• App Management - Managing your app, updating, security, web server configuration, etc
• Troubleshooting - Common errors and problems, and how to fix them

Development and Contributing

• Developing - Running Dashy development server locally, and general workflow
• Development Guides - Common development tasks, to help new contributors
• Contributing - How you can help keep Dashy alive
• Showcase - See how others are using Dashy, and share your dashboard
• Credits - List of people and projects that have made Dashy possible
• Release Workflow - Info about releases, CI and automated tasks

Feature Docs

• Authentication - Guide to setting up authentication to protect your dashboard
• Alternate Views - Outline of available pages / views and item opening methods
• Backup & Restore - Guide to backing up config with Dashy's cloud sync feature
• Icons - Outline of all available icon types for sections and items, with examples
• Language Switching - Details on how to switch language, or add a new locale
• Pages and Sections - Multi-page support, sections, items and sub-items
• Status Indicators - Using Dashy to monitor uptime and status of your apps
• Searching & Shortcuts - Searching, launching methods + keyboard shortcuts
• Theming - Complete guide to applying, writing and modifying themes + styles
• Widgets - List of all dynamic content widgets, with usage guides and examples

Misc

• Privacy & Security - List of requests, potential issues, and security resources
• License - Copy of the MIT License
• Legal - Licenses of direct dependencies
• Code of Conduct - Contributor Covenant Code of Conduct
• Changelog - Details of recent changes, and historical versions