Skip to content

docs: Write import/export documentation #6

@ggfevans

Description

@ggfevans

Summary

Document import/export and sharing features.

Migrated from: RackulaLives/www#17

Content Outline

Data Storage

  • Browser localStorage auto-save
  • Session persistence
  • What happens when you clear browser data

Save/Load (.Rackula.zip)

  • Folder-based ZIP archive format
  • YAML configuration files
  • Embedded device images
  • Loading saved layouts

Export Formats

PNG/JPEG (Raster)

  • Pixel-perfect image export
  • Quality and compression options

SVG (Vector)

  • Scalable vector export
  • Editing in Illustrator/Inkscape

PDF (Document)

  • US Letter format
  • Auto-orientation (portrait/landscape)

CSV (Spreadsheet)

  • Device inventory list
  • Import into Excel/Google Sheets

Export Options

  • Scope: all devices or selected only
  • Include/exclude rack names
  • Include/exclude device legend
  • Background: dark, light, or transparent
  • View: front, rear, or both
  • Display mode selection
  • QR code inclusion

Sharing

Share Links

  • Generate compressed shareable URLs
  • Base64url encoding with zlib compression
  • Minimal layout format (only used device types)
  • URL-based layout reconstruction
  • Character limit considerations

QR Codes

  • QR code generation for scanning
  • Fixed spec: Version 24, Error Correction L (~1,588 char capacity)
  • "Scan to open in Rackula" label
  • Copy and download options

Share Dialog

  • Copy URL to clipboard
  • Display QR code
  • URL preview

Acceptance Criteria

  • All export formats documented with examples
  • Step-by-step export instructions
  • Share link generation explained
  • QR code limitations documented
  • File format specifications

Test Requirements

  • Build completes without errors
  • Export examples are accurate

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:contentDocumentation contentreadyReady for implementationsize:mediumModerate effort

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions