docs: Add GitHub Pages documentation site - #297
Conversation
Fixes DouglasHalse#177 Adds documentation website for the project using GitHub Pages.
There was a problem hiding this comment.
Pull request overview
This PR adds a GitHub Pages documentation website for the Snack Attack Track project, providing a professional landing page to showcase features, deployment guides, and project information.
Key Changes
- Created a comprehensive single-page documentation site with modern responsive design
- Added GitHub Pages configuration with Jekyll settings
- Included setup instructions and local development guide
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 12 comments.
| File | Description |
|---|---|
| docs/index.html | Complete HTML documentation site with inline CSS, featuring project overview, features, quick start guides, hardware requirements, and links to GitHub resources |
| docs/_config.yml | Jekyll configuration file specifying theme and metadata for GitHub Pages |
| docs/README.md | Documentation for maintaining and deploying the GitHub Pages site, including local development instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <div class="feature-card"> | ||
| <h3>🔧 Admin Manual</h3> | ||
| <p>Instructions for managing inventory, users, system settings, and viewing store statistics.</p> | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack#security" class="btn btn-secondary" style="margin-top: 1rem;">Admin Docs</a> |
There was a problem hiding this comment.
The inline style attribute should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
| <p style="text-align: center; font-size: 1.1rem; max-width: 800px; margin: 0 auto;"> | ||
| Snack Attack Track™ is open source and welcomes contributions! Whether you're fixing bugs, | ||
| adding features, or improving documentation, we'd love your help. | ||
| </p> | ||
| <div style="text-align: center; margin-top: 2rem;"> |
There was a problem hiding this comment.
The inline style attributes should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
| title: Snack Attack Track™ | ||
| description: Open-source touchscreen kiosk software for smart snack management on Raspberry Pi |
There was a problem hiding this comment.
The 'title' and 'description' fields in the Jekyll config won't have any effect since the site uses a standalone HTML file that defines its own title and meta tags in the head section. Consider removing these unused fields or document that they're reserved for future Jekyll integration.
| title: Snack Attack Track™ | |
| description: Open-source touchscreen kiosk software for smart snack management on Raspberry Pi |
| theme: jekyll-theme-minimal | ||
| title: Snack Attack Track™ | ||
| description: Open-source touchscreen kiosk software for smart snack management on Raspberry Pi | ||
| show_downloads: true |
There was a problem hiding this comment.
The 'show_downloads' configuration won't have any effect since the site uses a custom HTML file rather than Jekyll's theme templates. Consider removing this unused configuration option.
| show_downloads: true |
|
|
||
| <div class="quick-start"> | ||
| <h3>Testing with VMware/VirtualBox</h3> | ||
| <p>Want to test without Raspberry Pi hardware? See our <a href="https://github.com/DouglasHalse/snackAttackTrack/blob/main/rpi-setup/testing-with-vmware.md" target="_blank">VMware Testing Guide</a></p> |
There was a problem hiding this comment.
Links that open in new tabs (target="_blank") should include rel="noopener noreferrer" for security and performance reasons. This prevents the new page from accessing the window.opener property and protects against potential security vulnerabilities.
| <p>Want to test without Raspberry Pi hardware? See our <a href="https://github.com/DouglasHalse/snackAttackTrack/blob/main/rpi-setup/testing-with-vmware.md" target="_blank">VMware Testing Guide</a></p> | |
| <p>Want to test without Raspberry Pi hardware? See our <a href="https://github.com/DouglasHalse/snackAttackTrack/blob/main/rpi-setup/testing-with-vmware.md" target="_blank" rel="noopener noreferrer">VMware Testing Guide</a></p> |
| <div class="feature-card"> | ||
| <h3>📖 User Guide</h3> | ||
| <p>Complete guide for end users on purchasing snacks, managing credits, and viewing transaction history.</p> | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack#readme" class="btn btn-secondary" style="margin-top: 1rem;">Read More</a> |
There was a problem hiding this comment.
The inline style attribute should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
| <div class="feature-card"> | ||
| <h3>🚀 Deployment Guide</h3> | ||
| <p>Step-by-step instructions for deploying to Raspberry Pi with auto-start configuration.</p> | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack/tree/main/rpi-setup" class="btn btn-secondary" style="margin-top: 1rem;">Deploy Now</a> |
There was a problem hiding this comment.
The inline style attribute should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
|
|
||
| <section> | ||
| <h2>📜 License</h2> | ||
| <p style="text-align: center; font-size: 1.1rem;"> |
There was a problem hiding this comment.
The inline style attribute should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
| <p style="margin-top: 1rem;"> | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack">GitHub</a> • | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack/issues">Issues</a> • | ||
| <a href="https://github.com/DouglasHalse/snackAttackTrack/discussions">Discussions</a> | ||
| </p> | ||
| <p style="margin-top: 1rem; opacity: 0.7; font-size: 0.9rem;"> |
There was a problem hiding this comment.
The inline style attributes should be defined in the CSS section rather than inline for better maintainability and consistency with the rest of the stylesheet.
| @@ -0,0 +1,7 @@ | |||
| # GitHub Pages Configuration for Snack Attack Track™ | |||
|
|
|||
| theme: jekyll-theme-minimal | |||
There was a problem hiding this comment.
The theme 'jekyll-theme-minimal' is specified but the site uses a custom index.html that bypasses Jekyll's templating system entirely. This configuration is unnecessary since the custom HTML file will be served directly. Consider removing the theme configuration or properly integrating with Jekyll layouts.
| theme: jekyll-theme-minimal |
Summary
Fixes #177
Adds documentation website for the project using GitHub Pages.