Skip to main content

Documentation Changelog - PDF Connect v3

2026-02-21 Manual URL Blocks Update​

  • Added new guide: manual-url-blocks.md
  • Updated publishing/setup/viewer/display docs to document manual product-template blocks
  • Added linked-vs-manual behavior clarifications
  • Added manual-specific troubleshooting checks
  • Updated sidebar navigation to include the new guide

Overview​

This changelog tracks the complete documentation renovation for PDF Connect v3, which introduced universal page linking, enhanced publishing workflows, and improved UI/UX.

Status Legend​

  • ✅ Completed - File updated with v3 features and ready for new screenshots
  • 🔄 In Progress - File being updated
  • ❌ Needs Update - Old file that needs v3 renovation
  • 📸 Needs Screenshots - Updated content ready for new images

Updated Files (v3)​

Core Guides - COMPLETED ✅​

intro-v3.md ✅​

  • Status: Completed, needs screenshots
  • Changes:
    • Updated to describe three display styles (Embedded PDF, PDF Button, PDF List)
    • Added universal linking capabilities (all page types)
    • Emphasized streamlined two-step publishing workflow
    • Added success stories and business value propositions
  • Old File: intro.md → intro-old.md
  • Screenshots Needed: 8 key screenshots identified in SCREENSHOT_REQUIREMENTS.md

tutorial-basics/link-pdfs-v3.md ✅​

  • Status: Completed, needs screenshots
  • Changes:
    • Complete rewrite for universal linking (all page types)
    • Enhanced search, pagination, and bulk selection features
    • Added cross-page linking strategies and troubleshooting
    • Strategic placement of screenshot placeholders
  • Old File: tutorial-basics/link-pdfs.md → tutorial-basics/link-pdfs-old.md
  • Screenshots Needed: 12 key screenshots identified

tutorial-basics/place-linked-pdf-v3.md ✅​

  • Status: Completed, needs screenshots
  • Changes:
    • Updated to reflect new publishing modal system
    • Added three distinct display styles with detailed use cases
    • Enhanced template selection and multi-block strategies
    • Performance optimization and troubleshooting sections
  • Old File: tutorial-basics/place-linked-pdf.md → tutorial-basics/place-linked-pdf-old.md
  • Screenshots Needed: 15 key screenshots identified

publishing-workflow-v3.md ✅​

  • Status: New file, completed, needs screenshots
  • Purpose: Comprehensive workflow guide for the new publishing system
  • Content:
    • Detailed best practices and troubleshooting
    • Template management strategies
    • Performance and UX optimization
  • Screenshots Needed: 8 workflow-specific screenshots identified

Files Needing Updates ❌​

Tutorial Basics​

  • tutorial-basics/upload-a-pdf.md ❌ - Needs v3 UI updates
  • tutorial-basics/account-and-subscription.md ❌ - Likely unchanged
  • tutorial-basics/paste-pdf-id.md ❌ - May be legacy feature
  • tutorial-basics/place-non-prd-page.md ❌ - Superseded by universal linking
  • tutorial-basics/place-linked-pdf-legacy.md ❌ - Legacy method, may archive

Tutorial Extras​

  • tutorial-extras/link-pdfs-bulk.md ❌ - Needs v3 bulk UI updates
  • tutorial-extras/external-pdfs.md ❌ - Needs v3 interface updates
  • tutorial-extras/pdf-viewers.md ❌ - Needs v3 viewer options
  • tutorial-extras/using-tags.md ❌ - Needs v3 tag interface
  • tutorial-extras/translate-your-site.md ❌ - Likely unchanged

Legacy Section​

  • legacy/button-designer.md ❌ - Superseded by theme editor blocks
  • legacy/pdf-placement.md ❌ - Superseded by publishing workflow

Screenshot Requirements​

Priority 1 - Core Workflow 📸​

  1. App Overview: Main PDF management interface
  2. Linking Interface: New page type dropdown and selection
  3. Publishing Modal: Three display style options
  4. Theme Editor: Adding PDF blocks to templates
  5. Resource Selection: Search and pagination in action

Priority 2 - Advanced Features 📸​

  1. Multi-block Templates: Examples of different styles on same page
  2. Bulk Operations: Spreadsheet import interface
  3. Settings & Customization: Block configuration options
  4. Mobile Views: How PDFs appear on mobile devices
  5. Performance Tools: Analytics and optimization features

Priority 3 - Use Cases 📸​

  1. Product Manual Example: Embedded PDF on product page
  2. Collection Catalog: PDF list on collection page
  3. Blog Resource: PDF button on article page
  4. Homepage Feature: PDF integration on index page
  5. Error States: What users see when things go wrong

Notes for Photography Session​

Interface Elements to Capture:​

  • New dropdown menus and selection interfaces
  • Enhanced modals with improved UX
  • Theme editor integration points
  • Mobile responsive views
  • Error and loading states

Content Examples to Prepare:​

  • Sample PDFs with realistic names/descriptions
  • Test products, collections, articles, pages
  • Various PDF sizes and types
  • Mobile device testing setup

Before/After Comparisons:​

  • Old vs. new linking interface
  • Legacy placement vs. theme editor blocks
  • Product-only vs. universal linking
  • Single display style vs. multiple options

Migration Strategy​

Phase 1: Core Documentation ✅​

  • Update main workflow guides
  • Create comprehensive feature documentation
  • Establish new file naming convention

Phase 2: Detailed Guides 🔄​

  • Update upload and account guides
  • Renovate bulk operations documentation
  • Update external PDF and viewer guides

Phase 3: Legacy Management 📋​

  • Archive superseded features
  • Create migration guides for existing users
  • Update navigation and cross-references

Phase 4: Visual Enhancement 📸​

  • Coordinate screenshot session
  • Replace all placeholder images
  • Add video tutorials for complex workflows
  • Test documentation with real merchants

Documentation Renovation System Implemented ✅​

File Management Strategy​

  • Naming Convention: All new files use -v3 suffix for easy identification
  • Old File Preservation: Original files renamed to -old suffix for reference
  • Change Tracking: Complete changelog with status updates and screenshot requirements

Image Management Strategy​

  • Old Images Removed: All outdated screenshots removed from documentation
  • Strategic Placeholders: [SCREENSHOT NEEDED: Description] placed where visuals add value
  • Requirements Documentation: Comprehensive screenshot requirements in dedicated file
  • Priority System: Three-tier priority system for screenshot capture

Quality Assurance Process​

  • Content Review: All v3 files reviewed for accuracy and completeness
  • Link Validation: Internal links updated to point to v3 versions
  • Consistency Check: Uniform formatting and terminology across all files
  • Accessibility: Alt text requirements and descriptive placeholders planned

Files Successfully Renovated​

Core Documentation ✅​

  1. intro-v3.md - Main introduction with v3 features
  2. tutorial-basics/link-pdfs-v3.md - Universal linking guide
  3. tutorial-basics/place-linked-pdf-v3.md - Enhanced publishing guide
  4. publishing-workflow-v3.md - Comprehensive workflow guide

Supporting Documentation ✅​

  1. DOCUMENTATION_CHANGELOG.md - Change tracking and status
  2. SCREENSHOT_REQUIREMENTS.md - Visual content planning

Next Phase Files (Planned)​

  • getting-started-v3.md - Modern onboarding guide
  • advanced-features-v3.md - Power user features
  • tutorial-basics/upload-a-pdf-v3.md - Updated upload process
  • tutorial-extras/link-pdfs-bulk-v3.md - Enhanced bulk operations

This systematic approach ensures:

  • Zero Content Loss: All original content preserved
  • Clear Progress Tracking: Easy to see what's done vs. what needs work
  • Professional Quality: Consistent, modern documentation standards
  • Future-Ready: Scalable system for ongoing updates

Success Metrics​

Documentation Quality:​

  • All v3 features documented comprehensively
  • Clear migration path from v2 to v3
  • Reduced support tickets about new features
  • Positive merchant feedback on clarity

Visual Enhancement:​

  • Modern screenshots reflecting current UI
  • Consistent visual language across all guides
  • Mobile-optimized documentation experience
  • Video supplements for complex workflows

This renovation will ensure our documentation matches the quality and sophistication of the new PDF Connect v3 features.