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 70ebce4da7
🔃 Merge branch 'master' of github.com:Lissy93/dashy into FEATURE/interactive-editor 		2021-10-26 09:36:48 +01:00
..
assets 💛 Updates repo diagram 2021-10-24 01:24:36 +00:00
showcase 🌟 Adds RickyCZ's dashboard to showcase 2021-09-18 02:42:03 +01:00
alternate-views.md 📝 Udates docs with new item opening methods 2021-10-23 01:41:08 +01:00
authentication.md 📝 Updates the Auth contents page 2021-09-20 17:08:47 +01: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 🗃️ Updates schema and config docs with default opening method, and new supported opening methods 2021-10-23 01:42:05 +01:00
contributing.md 📝 Updates URL to TypeForm survey 2021-10-17 14:41:42 +01:00
credits.md 💜 Updates contributors list 2021-10-24 02:23:32 +01:00
deployment.md 📝 Updates docs 2021-10-15 22:18:53 +01:00
developing.md 📝 Small docs changes 2021-10-10 21:18:59 +01:00
development-guides.md 📝 Adds Netlify functions tutorial, and documens release workflow 2021-09-19 14:18:44 +01:00
icons.md 📝 Updates icon docs 2021-10-02 22:43:27 +01:00
management.md 📝 Adds info for custom domain and remote access into Management docs 2021-10-23 19:29:01 +01:00
multi-language-support.md 📝 Updates maintence and language docs 2021-09-18 18:15:10 +01:00
privacy.md 📝 Updates privacy docs, re Generative icons 2021-09-29 19:43:58 +01:00
quick-start.md 📝 Adds info for custom domain and remote access into Management docs 2021-10-23 19:29:01 +01:00
readme.md 📝 Updates documentation, includes release schedule 2021-09-12 17:08:57 +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 🌟 Add @skoogee's epic dash to the showcase (#279) 2021-10-17 12:27:33 +01:00
status-indicators.md 🩹 Re: #251 - Updates endpoint for status check debugging 2021-09-27 18:30:06 +01:00
theming.md 📝 Adds docs for the UI theme configurator 2021-07-18 20:47:15 +01:00
troubleshooting.md 📝 Adds info for custom domain and remote access into Management docs 2021-10-23 19:29:01 +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 Dashy's cloud sync feature
  • Icons - Outline of all available icon types for sections and items
  • Language Switching - Details on how to switch language, or add a new locale
  • Status Indicators - Using Dashy to monitor uptime and status of your apps
  • Searching & Shortcuts - Finding and launching your apps, and using keyboard shortcuts
  • Theming - Complete guide to applying, writing and modifying themes and styles

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