tyler.durden
/
dashy
mirror of https://github.com/Lissy93/dashy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dashy/docs
History
Tobias 631883a0d8
typo 		2024-03-05 07:01:59 +01:00
..
assets 💛 Updates repo diagram 2024-03-03 01:25:06 +00:00
showcase Fix various typos 2022-08-23 11:22:47 +02:00
alternate-views.md 📝 corrected some typos in the docs 2023-08-20 14:22:23 +02:00
authentication.md 📝 Updates auth note 2024-02-16 20:26:54 +00:00
backup-restore.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
configuring.md 🗃 Adds optional item.rel attribute (fixes #1477) 2024-02-28 12:06:21 +00:00
contributing.md Fix various typos 2022-08-23 11:22:47 +02:00
credits.md 💜 Updates contributors list 2024-03-03 01:23:55 +00:00
deployment.md 🔂 Resolve conflicts 2024-02-26 14:38:58 +00:00
developing.md Added BACKUP_DIR env 2023-09-22 20:27:31 +06:00
development-guides.md [Docs] Improved minor errors in development-guides.md file 2023-11-30 20:05:55 +05:00
icons.md Update generative icon API 2023-10-14 15:52:41 -04:00
management.md Fix missed bolding 2022-08-23 11:42:19 +02:00
multi-language-support.md Update multi-language-support.md 2023-09-05 14:30:54 +02:00
pages-and-sections.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
privacy.md Fix various typos 2022-08-23 11:22:47 +02:00
quick-start.md Add Easypanel Deployment Method 2023-06-25 14:22:18 +03:00
readme.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
release-workflow.md Fix various typos 2022-08-23 11:22:47 +02:00
searching.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
showcase.md typo 2024-03-05 07:01:59 +01:00
status-indicators.md Fix inconsistent markdown formatting. 2022-08-23 09:57:02 +02:00
theming.md Fix various typos 2022-08-23 11:22:47 +02:00
troubleshooting.md 🔂 Resolve conflicts 2024-02-26 14:38:58 +00:00
widgets.md 🔀 Merge pull request #1460 from alayham/fix-proxmox-widger-sorting 2024-02-24 22:29:57 +00:00

readme.md

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