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 dbb261c859
🔀 Merge pull request #740 from marekful/FEATURE/nextcloud-widgets 
Feature/nextcloud widgets
Credit to @marekful
 		2022-06-20 21:34:32 +01:00
..
assets 💛 Updates repo diagram 2022-06-19 01:33:48 +00:00
showcase Add dr460nf1r3's Dashy 2022-05-29 17:13:42 +02:00
alternate-views.md 📝 Refactors loads of docs 2022-01-22 20:43:38 +00:00
authentication.md Add basic documentation 2022-06-02 08:10:42 +02: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 Add contents urls 2022-06-02 12:49:46 +02:00
contributing.md ✏️ fix broken `Development Docs` link in contributing.md 2022-04-25 03:22:39 +09:00
credits.md 💜 Updates contributors list 2022-06-19 02:29:12 +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 🛠️ fix: Changes repo link to new organization 2022-04-29 12:42:46 +02:00
management.md Fix typo in management.md 2022-06-06 20:34:49 +02:00
multi-language-support.md 📝 Updates maintence and language docs 2021-09-18 18:15:10 +01:00
pages-and-sections.md 📝 Adds sub-items docs 2022-05-20 12:50:34 +01:00
privacy.md 📝 Adds docs for domain name monitor widget 2022-06-04 21:12:25 +01:00
quick-start.md 📝 Updates readme and getting-started guide 2021-10-30 23:55:13 +01:00
readme.md Update readme.md 2022-06-19 19:38:17 +02: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 @Brewhack's awesome dash (#680) 2022-06-04 21:12:25 +01:00
status-indicators.md 📝 Updates docs with status check custom response code (#456) 2022-01-28 23:26:40 +00:00
theming.md ✨ Adds option for page-specific custom styling 2022-04-30 23:22:02 +01:00
troubleshooting.md 📝 Adds copy to clipboard to troubleshooting guide (#681) 2022-06-04 21:12:25 +01:00
widgets.md 📝 Add widget documentation 2022-06-20 18:49:22 +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