Docs
User Guide README

User Guide README

README file for the Digital Signage Platform user guide documentation with setup instructions and overview.

Contents

  • user-guide.md: Complete user guide covering all platform features
  • screenshots/: Folder for screenshots and video placeholders

Documentation Structure

The user guide covers the following topics:

  1. Login Flow: How to access the platform using email/password or Google authentication
  2. Media Management: Uploading files and creating interactive app content
  3. Screen Creation: Setting up and managing display screens
  4. Publications: Creating and updating content layouts for screens

Adding Screenshots and Videos

To complete this user guide, add screenshots and videos to the screenshots/ folder with the following naming convention:

Login Section

  • login-screen.png - Main login screen
  • login-process.gif - Login demonstration
  • google-login.png - Google sign-in option
  • email-verification.png - Email verification screen

Media Section

  • media-library.png - Media library overview
  • upload-image.gif - Image upload process
  • upload-video.gif - Video upload with progress
  • app-selection.png - App types grid
  • youtube-app-form.png - YouTube app configuration
  • weather-app-form.png - Weather app configuration
  • clock-app-form.png - Clock app configuration
  • message-board-app-form.png - Message board configuration
  • text-scroll-app-form.png - Text scroll configuration
  • rss-app-form.png - RSS feed configuration
  • web-url-app-form.png - Web URL configuration
  • qr-code-app-form.png - QR code configuration
  • product-app-form.png - Product showcase configuration
  • restaurant-app-form.png - Restaurant menu configuration
  • playlist-app-form.png - Playlist configuration
  • media-folders.png - Folder organization

Screens Section

  • screens-list.png - Screens overview
  • create-screen-form.png - Screen creation form
  • screen-auth.gif - Screen authentication process
  • manage-screens.png - Screen management interface

Publications Section

  • publications-list.png - Publications overview
  • publication-editor.png - Publication editor interface
  • publication-name.png - Name field
  • layout-templates.png - Layout selection
  • assign-media.gif - Adding media to regions
  • media-in-regions.png - Complete layout with media
  • assign-screens.png - Screen assignment
  • display-settings.png - Display configuration
  • save-publication.png - Save button
  • update-publication.gif - Update process
  • multi-region-layout.png - Complex layout example
  • preview-mode.png - Preview interface

How to Use This Documentation

For End Users

  1. Open user-guide.md in any Markdown viewer or text editor
  2. Follow the step-by-step instructions for each feature
  3. Screenshots will help visualize each step (once added)

For Documentation Maintainers

  1. Take screenshots/videos following the naming convention above
  2. Save them in the screenshots/ folder
  3. Update the guide if features change
  4. Keep the FAQ section updated with common issues

Contributing

When updating this documentation:

  • Use clear, non-technical language
  • Include screenshots for every major step
  • Add troubleshooting tips based on common issues
  • Update the version number and last updated date
  • Test all instructions to ensure accuracy

Documentation Version

Current Version: 1.0 Last Updated: [To be filled]

Support

For questions about this documentation or the platform:

  • Contact your platform administrator
  • Refer to technical documentation for advanced features
  • Submit feedback for documentation improvements