dashy/docs
2024-09-08 01:28:43 +00:00
..
assets Update documentation 2024-09-01 01:29:19 +00:00
showcase Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
alternate-views.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
authentication.md Update documentation 2024-08-17 14:34:23 +00:00
backup-restore.md Update documentation 2024-04-20 11:07:47 +00:00
changelog.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
code-of-conduct.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
configuring.md Update documentation 2024-08-17 14:34:23 +00:00
contributing.md Update documentation 2024-03-07 18:32:22 +00:00
credits.md Update documentation 2024-09-08 01:28:43 +00:00
deployment.md Update documentation 2024-08-07 10:47:09 +00:00
developing.md Update documentation 2024-04-20 11:07:47 +00:00
development-guides.md Update documentation 2024-04-20 11:07:47 +00:00
icons.md Update documentation 2024-04-20 11:07:47 +00:00
license.md Adds Changelog, Privacy and License 2021-08-29 18:42:18 +01:00
management.md Update documentation 2024-04-20 11:07:47 +00:00
multi-language-support.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
pages-and-sections.md Update documentation 2024-05-24 21:10:13 +00:00
privacy.md Update documentation 2024-08-17 14:33:01 +00:00
quick-start.md Update documentation 2024-04-28 21:59:15 +00:00
readme.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
release-workflow.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
searching.md Updated all the docs from master 2023-06-10 12:54:53 +01:00
showcase.md Update documentation 2024-03-07 18:32:22 +00:00
status-indicators.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
theming.md Freshly generated docs, to test prod site 2024-03-06 21:59:45 +00:00
troubleshooting.md Update documentation 2024-04-20 11:07:47 +00:00
widgets.md Update documentation 2024-08-17 14:33:01 +00:00

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