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:
- Login Flow: How to access the platform using email/password or Google authentication
- Media Management: Uploading files and creating interactive app content
- Screen Creation: Setting up and managing display screens
- 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 screenlogin-process.gif- Login demonstrationgoogle-login.png- Google sign-in optionemail-verification.png- Email verification screen
Media Section
media-library.png- Media library overviewupload-image.gif- Image upload processupload-video.gif- Video upload with progressapp-selection.png- App types gridyoutube-app-form.png- YouTube app configurationweather-app-form.png- Weather app configurationclock-app-form.png- Clock app configurationmessage-board-app-form.png- Message board configurationtext-scroll-app-form.png- Text scroll configurationrss-app-form.png- RSS feed configurationweb-url-app-form.png- Web URL configurationqr-code-app-form.png- QR code configurationproduct-app-form.png- Product showcase configurationrestaurant-app-form.png- Restaurant menu configurationplaylist-app-form.png- Playlist configurationmedia-folders.png- Folder organization
Screens Section
screens-list.png- Screens overviewcreate-screen-form.png- Screen creation formscreen-auth.gif- Screen authentication processmanage-screens.png- Screen management interface
Publications Section
publications-list.png- Publications overviewpublication-editor.png- Publication editor interfacepublication-name.png- Name fieldlayout-templates.png- Layout selectionassign-media.gif- Adding media to regionsmedia-in-regions.png- Complete layout with mediaassign-screens.png- Screen assignmentdisplay-settings.png- Display configurationsave-publication.png- Save buttonupdate-publication.gif- Update processmulti-region-layout.png- Complex layout examplepreview-mode.png- Preview interface
How to Use This Documentation
For End Users
- Open
user-guide.mdin any Markdown viewer or text editor - Follow the step-by-step instructions for each feature
- Screenshots will help visualize each step (once added)
For Documentation Maintainers
- Take screenshots/videos following the naming convention above
- Save them in the
screenshots/folder - Update the guide if features change
- 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