dashy/docs
2021-08-05 22:00:29 +01:00
..
assets 💙 Updates contributor SVG 2021-08-05 09:03:36 +00:00
showcase 🌟 Adds homelab to showcase 2021-07-16 22:10:04 +01:00
alternate-views.md 📝 Todo, write docs for alternate views 2021-07-30 16:33:14 +01:00
authentication.md 📝 Updates docs :) 2021-06-22 22:32:03 +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 🗃️ Adds 'enableErrorReporting' to schema and config docs 2021-08-01 12:19:31 +01:00
contributing.md 📝 Adds socials into Contributing docs 2021-08-04 16:10:04 +01:00
credits.md 💛 Updates contributors list 2021-08-05 10:03:33 +01:00
deployment.md 📝 Revereted to previous deploy list 2021-07-31 16:51:50 +01:00
developing.md 📝 Adds link to Vue styleguide 2021-08-05 22:00:29 +01:00
development-guides.md ✏️ Fixes typos in the docs 2021-07-26 22:50:55 +01:00
icons.md 📝 Updates icon screenshots 2021-07-03 19:51:39 +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 📝 Adds Privacy and Security docs 2021-08-01 13:19:49 +01:00
readme.md 📝 Adds Privacy and Security docs 2021-08-01 13:19:49 +01:00
showcase.md 🌟 Adds homelab to showcase 2021-07-16 22:10:04 +01:00
status-indicators.md 📝 Updates docs with new features for status checking header and url 2021-06-27 13:33:30 +01:00
theming.md 📝 Adds docs for the UI theme configurator 2021-07-18 20:47:15 +01:00
troubleshooting.md 🍻 Death by documentation... This will need spell checking in the morning 2021-07-26 22:43:46 +01:00

Dashy Docs

Running Dashy

  • Deployment - Getting Dashy up and running
  • 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

Feature Docs

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