GPDoc logoGPDoc
Docs
Workspace Management

Configuring offline workspaces

Keep GPDoc useful in local-first workspaces while staying ready for selective sync.

GPDoc is offline-first by design. Follow these steps to configure a workspace that operates without constant connectivity.

Prerequisites

  • GPDoc desktop app or CLI installed on each contributor’s machine.
  • Access to your organization’s Git remote (even if sync is delayed).
  • Local encryption policy defined by your security team.

Setup checklist

  1. Create a workspace using gpdoc init and select the offline-first profile.
  2. Disable auto-sync by setting sync.mode = manual in workspace.config.json.
  3. Define storage paths so sensitive docs live on encrypted drives.
  4. Cache runtimes with gpdoc runtimes preload for Python, TypeScript, and SQL.
  5. Share templates via the workspace repository so everyone starts from the same component library.

Working offline

  • Draft documents, notebooks, and slides as usual. GPDoc queues commits locally.
  • Use gpdoc review to simulate pull requests and collect feedback in person or over secure channels.
  • Export HTML or PDF bundles for stakeholders who cannot access the workspace directly.

Syncing on your schedule

When the security team opens a sync window:

# review queued commits
gpdoc sync status

# push to the remote when approved
gpdoc sync push

Resolve conflicts locally. GPDoc surfaces component-level diffs, so merges stay manageable even after long offline stretches.

Remember

Keep an offline copy of your automation scripts so exports and lint checks stay available without a network connection.

That is enough to keep local work moving while preserving the option to publish when the time is right.

Next guide

Publish GPDoc hubs to your custom domain

Map Netlify, Vercel, or CDN hosting so your docs look and feel like the rest of your product.