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
Alicia Sykes dfb12ec8d2 📝 Updates docs for multi-page support 2022-04-30 22:49:07 +01:00
..
assets 💛 Updates repo diagram 2022-04-24 01:32:40 +00:00
showcase Add 12-evo-dashboard.png 2021-11-05 01:02:13 +01:00
alternate-views.md 📝 Refactors loads of docs 2022-01-22 20:43:38 +00:00
authentication.md 📝 Adds link to setting headers for KC 2022-03-01 14:05:01 +00:00
backup-restore.md Adds an example TOML file, and link to backend source code 2021-06-17 22:59:19 +01:00
configuring.md 🗃️ Adds pages to config docs 2022-04-26 22:26:27 +01:00
contributing.md 📝 Refactors loads of docs 2022-01-22 20:43:38 +00:00
credits.md 💜 Updates contributors list 2022-04-24 02:29:01 +01:00
deployment.md 📝 Corrects volume path in compose (#601) 2022-04-15 16:26:45 +01:00
developing.md 📝 Refactors loads of docs 2022-01-22 20:43:38 +00:00
development-guides.md 📝 Adds guide on permissioning components 2022-02-12 21:30:52 +00:00
icons.md ✨ Adds icon.horse to supported favicon APIs 2021-12-29 17:52:29 +00:00
management.md 📝 Updates reverse proxy docs 2022-03-01 13:33:20 +00:00
multi-language-support.md 📝 Updates maintence and language docs 2021-09-18 18:15:10 +01:00
pages-and-sections.md 📝 Updates docs for multi-page support 2022-04-30 22:49:07 +01:00
privacy.md ✨ Adds Mullvad and IP blacklist check widgets 2022-04-14 19:02:51 +01:00
quick-start.md 📝 Updates readme and getting-started guide 2021-10-30 23:55:13 +01:00
readme.md 📝 Starts writing multi-page docs 2022-04-26 22:27:02 +01:00
release-workflow.md 📝 Documents the deployment process 2021-09-19 14:24:04 +01:00
searching.md 📝 Udates docs with new item opening methods 2021-10-23 01:41:08 +01:00
showcase.md 🌟 Adds new screenshot to showcase 2022-04-14 14:31:28 +01:00
status-indicators.md 📝 Updates docs with status check custom response code (#456) 2022-01-28 23:26:40 +00:00
theming.md docs:fix theming title and themes' count 2022-01-29 09:53:13 +05:30
troubleshooting.md 📝 Starts writing multi-page docs 2022-04-26 22:27:02 +01:00
widgets.md 📝 Fixes docs link to Synology Download Station 2022-04-23 22:53:35 +01:00

readme.md

Dashy Docs

Running Dashy

  • Quick Start - TDLR 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