diff --git a/docs/readme.md b/docs/readme.md index 96802a47..64fa3656 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,13 +1,20 @@ -## Contents +![Dashy Docs](https://i.ibb.co/4mdNf7M/heading-docs.png) -- [Deployment](/docs/deployment.md) -- [Configuring](/docs/configuring.md) -- [Developing](/docs/developing.md) -- [Contributing](/docs/contributing.md) -- [User Guide](/docs/user-guide.md) -- [Troubleshooting](/docs/troubleshooting.md) -- [Backup & Restore](/docs/backup-restore.md) -- [Status Indicators](/docs/status-indicators.md) -- [Theming](/docs/theming.md) -- [Icons](/docs/icons.md) -- [Authentication](/docs/authentication.md) +### Running Dashy +- [Deployment](/docs/deployment.md) - Getting Dashy up and running +- [Configuring](/docs/configuring.md) - Complete list of all available options in the config file +- [Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc +- [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them + +### Development and Contributing +- [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow +- [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors +- [Contributing](/docs/contributing.md) - How to contribute to Dashy +- [Showcase](/docs/showcase.md) - See how others are using Dashy, and share your dashboard + +### Feature Docs +- [Backup & Restore](/docs/backup-restore.md) - Guide to Dashy's cloud sync feature +- [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps +- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes and styles +- [Icons](/docs/icons.md) - Outline of all available icon types for sections and items +- [Authentication](/docs/authentication.md) - Guide to setting up authentication to protect your dashboard