workPro Documentation
Direct URL:
http://your-domain.com/workpro/public/user-manual.php
| Section | URL | Purpose |
|---|---|---|
| Getting Started | ?section=getting-started |
Introduction & orientation |
| Dashboard Home | ?section=dashboard-home |
Dashboard overview |
| Navigation | ?section=navigation |
UI navigation guide |
| Work Entry | ?section=work-entry |
Creating work entries |
| Quantity Management | ?section=quantity-management |
BOQ & quantities |
| Photo Upload | ?section=photo-upload |
Photo documentation |
| Reporting | ?section=reporting |
Reports & analytics |
| Approval Process | ?section=approval-process |
Work approvals |
| BOQ Management | ?section=boq-management |
BOQ operations |
| Administration | ?section=administration |
Admin functions |
| Troubleshooting | ?section=troubleshooting |
Problem solving |
| FAQ | ?section=faq |
Common questions |
| Appendix | ?section=appendix |
Reference materials |
http://domain/workpro/public/user-manual.php?section=work-entry
http://domain/workpro/public/user-manual.php?section=photo-upload
http://domain/workpro/public/user-manual.php?section=quantity-management
http://domain/workpro/public/user-manual.php?section=approval-process
http://domain/workpro/public/user-manual.php?section=reporting
http://domain/workpro/public/user-manual.php?section=reporting
http://domain/workpro/public/user-manual.php?section=faq
http://domain/workpro/public/user-manual.php?section=troubleshooting
http://domain/workpro/public/user-manual.php?section=faq
✅ Automatic Table of Contents - Generated from headings
✅ Sidebar Navigation - Quick access to all sections
✅ Responsive Design - Works on desktop, tablet, mobile
✅ Smooth Scrolling - Click TOC items to jump
✅ Active Section Highlighting - Know where you are
✅ Professional Styling - Clean, modern appearance
✅ Print Friendly - Can print documentation
✅ No Dependencies - Works with any server
Documentation Source Files:
/workpro/docs/DASHBOARD_USER_MANUAL_FULL.md
/workpro/docs/DASHBOARD_USER_MANUAL_TOC.md
/workpro/docs/features/*/
/workpro/docs/quick-ref/
User Manual Viewer:
/workpro/public/user-manual.php
Setup Guides:
/workpro/SETUP_USER_MANUAL_VIEWER.md
/workpro/MARKDOWN_TO_PHP_GUIDE.md
<!-- Add to your navigation menu -->
<a href="<?php echo $baseUrl; ?>public/user-manual.php" class="nav-link">
<i class="fas fa-book"></i> User Manual
</a>
<!-- Or with icon and badge -->
<a href="<?php echo $baseUrl; ?>public/user-manual.php" class="nav-link">
<i class="fas fa-question-circle"></i> Help & Docs
<span class="badge bg-info">NEW</span>
</a>
<?php
$baseUrl = 'http://your-domain.com/workpro/';
$manualUrl = $baseUrl . 'public/user-manual.php';
?>
<a href="<?php echo $manualUrl; ?>">User Manual</a>
<a href="<?php echo $manualUrl; ?>?section=troubleshooting">Troubleshooting</a>
<a href="<?php echo $manualUrl; ?>?section=faq">FAQ</a>
→ Direct to: ?section=navigation
→ Direct to: ?section=work-entry
→ Direct to: ?section=troubleshooting
→ Direct to: ?section=faq
→ Direct to: ?section=approval-process
→ Direct to: ?section=reporting
The manual is 100% mobile responsive:
Just access the same URL on any device!
To enable search functionality, uncomment the search box in user-manual.php:
// Around line 503, change:
.search-box {
display: none; /* ← Change to display: flex; */
}
This enables the search input in the header.
# Backup your markdown files
cp -r docs/ docs_backup/
cp SETUP_USER_MANUAL_VIEWER.md SETUP_USER_MANUAL_VIEWER.backup.md
# Add to version control
git add public/user-manual.php
git add docs/DASHBOARD_USER_MANUAL_FULL.md
git add SETUP_USER_MANUAL_VIEWER.md
git commit -m "Add HTML user manual viewer"
Q: Page shows "Documentation Not Found"
$documentFiles array/docs/ directoryQ: Sidebar doesn't collapse on mobile
Q: Markdown not formatting correctly
```code```[text](url)Q: Styling looks broken
Documentation Coverage:
User Manual Viewer:
For users accessing the manual:
First Visit:
When Learning Features:
When Having Issues:
Need help with the manual viewer?
SETUP_USER_MANUAL_VIEWER.mdMARKDOWN_TO_PHP_GUIDE.mdIssues with manual content?
Status: ✅ Ready for Production
Version: 1.0
Date: December 17, 2025
Files: ✅ All created and functional
Testing: ✅ Syntax verified
Enjoy your new documentation system! 📚