Documentation Pack Changelog#

Version 1.0.0 - November 8, 2025#

New Documentation Files#

Core Documentation (13 files):

• _index.md - Main documentation index with table of contents
• getting-started.md - Quick start guide for new users
• onboarding.md - Comprehensive onboarding walkthrough
• key-features.md - Overview of all AssetVault capabilities
• bulk-upload.md - Detailed guide for importing multiple assets
• import-export.md - Data import and export workflows
• fixed-assets.md - Complete fixed assets management guide
• depreciation-engine.md - Depreciation calculation documentation
• lease-engine-coming-soon.md - IFRS 16 lease accounting guide
• dashboards.md - Dashboard and analytics documentation
• troubleshooting.md - Common issues and solutions
• faq.md - Frequently asked questions
• glossary.md - Asset management terminology

Policy Documents (11 files under /docs/policies/):

• privacy-policy.md - Comprehensive privacy policy
• security-policy.md - Security measures and practices
• gdpr-compliance.md - GDPR compliance documentation
• data-subject-rights.md - How to exercise GDPR rights
• data-deletion-policy.md - Data deletion procedures and timelines
• data-retention-policy.md - Data retention periods by type
• data-processing-addendum-dpa.md - Standard DPA for customers
• data-breach-notification-policy.md - Breach response procedures
• backup-and-disaster-recovery.md - Backup and DR policy
• cookie-policy.md - Cookie usage and control
• terms-of-use.md - Terms of service

Total: 24 comprehensive markdown documentation files

New Features#

Help Link System:

• Added /myapp/config/docs.php - Configuration for help link feature flag
• Added /myapp/resources/views/components/help-link.blade.php - Reusable help link Blade component
• Added /docs/help-map.json - Mapping file for help link routes
• Feature gated by DOCS_HELP_ENABLED config (default: false)

Help Link Component Features:

• Accessible design with aria-label
• Focus styles for keyboard navigation
• Only renders when config flag is enabled
• Supports deep links to specific sections
• Small, unobtrusive "?" icon
• Tailwind CSS styling for consistency

Configuration Changes#

Environment Variables:

• Added DOCS_HELP_ENABLED=false to .env.example

Config Files:

• New: config/docs.php with help_enabled setting

Directory Structure#

/docs/
  ├── _index.md
  ├── getting-started.md
  ├── onboarding.md
  ├── key-features.md
  ├── bulk-upload.md
  ├── import-export.md
  ├── fixed-assets.md
  ├── depreciation-engine.md
  ├── lease-engine-coming-soon.md
  ├── dashboards.md
  ├── troubleshooting.md
  ├── faq.md
  ├── glossary.md
  ├── help-map.json
  ├── media/               (for screenshots and GIFs)
  │   └── README.md
  └── policies/
      ├── privacy-policy.md
      ├── security-policy.md
      ├── gdpr-compliance.md
      ├── data-subject-rights.md
      ├── data-deletion-policy.md
      ├── data-retention-policy.md
      ├── data-processing-addendum-dpa.md
      ├── data-breach-notification-policy.md
      ├── backup-and-disaster-recovery.md
      ├── cookie-policy.md
      └── terms-of-use.md

/myapp/
  ├── config/
  │   └── docs.php          (NEW)
  └── resources/views/components/
      └── help-link.blade.php  (NEW)

Documentation Highlights#

Getting Started Guide:

• Step-by-step account setup
• Company configuration
• First asset creation
• Bulk upload introduction
• Data deletion request instructions

GDPR Compliance Suite:

• Complete GDPR compliance documentation
• Data subject rights with self-service options
• Data deletion policy with clear timelines
• Comprehensive DPA for B2B customers
• Breach notification procedures (72-hour timeline)

User-Friendly Features:

• Clear table of contents in every section
• Numbered step-by-step tutorials
• Troubleshooting sections
• FAQ with common scenarios
• Glossary with domain terminology
• Cross-references between documents

Policy Customization:

• All policies include placeholders for customization:
  • [[COMPANY NAME]]
  • [[CONTACT EMAIL]]
  • [[DPO EMAIL]]
  • [[REGISTERED ADDRESS]]
  • [[EFFECTIVE DATE]]
  • etc.

Media Placeholders#

The following tutorial GIFs and screenshots are referenced in documentation:

• media/create-asset-tutorial.gif
• media/bulk-upload-tutorial.gif
• media/depreciation-settings.gif
• media/lease-calculator.gif
• media/dashboard-overview.gif
• media/export-tutorial.gif
• Various screenshot placeholders

Note: Actual media files should be generated by capturing the live UI and creating optimized GIFs (≤ 3MB each).

Integration Points#

Help Links Ready for Integration (when DOCS_HELP_ENABLED=true):

• Asset summary page → /docs/fixed-assets.md
• Asset create/edit → /docs/fixed-assets.md#creating-assets
• Bulk upload → /docs/bulk-upload.md
• Depreciation settings → /docs/depreciation-engine.md#depreciation-settings
• Dashboard → /docs/dashboards.md
• Lease engine try page → /docs/lease-engine-coming-soon.md
• Import/export pages → /docs/import-export.md

Usage Instructions#

To Enable Help Links:

1. Set DOCS_HELP_ENABLED=true in .env
2. Help icons will appear next to key UI elements
3. Clicking opens documentation in new tab

To Customize Policies:

1. Replace all [[PLACEHOLDER]] values with actual information
2. Review and adapt content to your specific needs
3. Have legal counsel review before publication
4. Update version and review dates

To Add Media:

1. Capture UI screenshots
2. Convert key flows to GIFs using tools like LICEcap or ScreenToGif
3. Optimize for web (≤ 3MB per GIF)
4. Save to /docs/media/ with kebab-case names
5. Update references in documentation

Technical Details#

Component Implementation:

• <x-help-link> Blade component
• Props: page (required), section (optional)
• Reads from help-map.json for URL mapping
• Fallback to /docs/{page} if not in map
• SVG question mark icon with hover states

Example Usage:

<x-help-link page="fixed-assets" />
<x-help-link page="bulk-upload" section="preview-and-validation" />

File Statistics#

• Total documentation files: 24 markdown files
• Total words: ~45,000 words
• Total lines: ~7,500 lines
• Code files: 2 (config + component)
• Configuration files: 1 (help-map.json)

Quality Assurance#

All documentation includes:

• ✅ Clear, concise language
• ✅ Step-by-step instructions
• ✅ Troubleshooting sections
• ✅ Related document cross-links
• ✅ Table of contents
• ✅ Consistent formatting
• ✅ Accessibility considerations

All policies include:

• ✅ GDPR compliance
• ✅ Clear legal language
• ✅ Customization placeholders
• ✅ Version tracking
• ✅ Review date fields
• ✅ Contact information
• ✅ Cross-references

Next Steps#

Before Production Use:

1. Review and customize all policy placeholders
2. Generate actual screenshots and tutorial GIFs
3. Have legal counsel review policies
4. Test help links in UI
5. Update media file references
6. Set appropriate review dates
7. Consider translations for international users

Future Enhancements:

• Video tutorials
• Interactive demos
• Searchable documentation
• Multi-language support
• API documentation (when API launches)
• In-app guided tours

Breaking Changes#

None - This is a new feature addition.

Migration Notes#

No migration required. Feature is entirely opt-in via config flag.

Contributors#

• Documentation framework and policies: AI-assisted generation
• Technical review required by: [[DPO NAME]], [[LEGAL TEAM]]
• Final approval: [[APPROVER NAME]]

Document Version: 1.0.0
Created: November 8, 2025
Next Review: [[REVIEW DATE]]