Lissy93/dashy
1
1
Fork 0
mirror of https://github.com/Lissy93/dashy.git synced 2024-12-25 01:42:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
31312a8af1
dashy/docs
History
Alicia Sykes 31312a8af1 Merge branch 'master' of github.com:Lissy93/dashy
2021-09-13 21:54:14 +01:00
..
assets 💙 Updates contributor SVG 2021-09-13 20:45:28 +00:00
showcase 🌟 Adds screenshots to showcase 2021-08-22 19:18:44 +01:00
alternate-views.md 📝 Adds alternate views page to docs 2021-08-21 17:17:02 +01:00
authentication.md 📝 Updates auth docs with Keycloak 2021-08-21 23:27:14 +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 🗃️ Update schema with SW off by default 2021-09-12 15:00:45 +01:00
contributing.md 📝 Updates Credits and Contributing docs 2021-09-12 13:13:45 +01:00
credits.md 💜 Updates contributors list 2021-09-12 13:16:49 +01:00
deployment.md 📝 Updates git clone with https instead of ssh 2021-08-19 20:09:48 +01:00
developing.md 📝 Inserts auto-generate visualization of src 2021-09-12 22:47:54 +01:00
development-guides.md 📝 Adds env vars to development docs, updates readme badges 2021-09-09 18:12:30 +01:00
icons.md 📝 Updates icon documentation 2021-09-04 21:15:14 +01:00
management.md 📝 Creates a separate file for instance managmnet 2021-07-22 22:46:39 +01:00
multi-language-support.md 📝 Removes curley braces breaking gh build, and updates contribs 2021-07-31 17:12:55 +01:00
privacy.md 📝 Updates documentation, includes release schedule 2021-09-12 17:08:57 +01:00
quick-start.md 📝 Updates git clone with https instead of ssh 2021-08-19 20:09:48 +01:00
readme.md 📝 Updates documentation, includes release schedule 2021-09-12 17:08:57 +01:00
release-workflow.md 📝 Updates documentation, includes release schedule 2021-09-12 17:08:57 +01:00
searching.md 📝 Adds docs for using search bangs 2021-09-11 20:37:13 +01:00
showcase.md 🌟 Adds screenshots to showcase 2021-08-22 19:18:44 +01:00
status-indicators.md 📝 Updates status check troubleshooting guide 2021-09-13 21:40:57 +01:00
theming.md 📝 Adds docs for the UI theme configurator 2021-07-18 20:47:15 +01:00
troubleshooting.md 📝 Updates status check troubleshooting guide 2021-09-13 21:40:57 +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